Guida SDK › Portal Integration › Web Services › Methods for Web Services › Report Methods › GetReportData

GetReportData

Description

This method returns report data as XML and optionally generates a GIF image with the report chart.

Syntax

A typical syntax for this method is shown. Note that the exact syntax to use depends on the type of protocol used to communicate with the web service.

XmlNode
 GetReportData (

string
 sessionID, 

int
 FavoriteID, 

int
 pictureRequest, 

int
 width, 

int
 height)

Parameter

Return Value

Report outputs differ according to report type. The Reports Web service adds a path specifies path to the generated report image:

For normal, compound and free-form reports (with chart):

<RESULT ... HAS_CHART ="1/0">
    <ITEM ...>
        .
	.
	.
       <PICTURE_PATH>"<REPORTID><NUM><COUNT>".JPG </ PICTURE_PATH >
     </ITEM>
</RESULT>

For Group reports:

<RESULT ... HAS_CHART =”1/0”>
    <ITEM ...>
        .
	.
	.
       <PICTURE_PATH>"<REPORTID><NUM><COUNT>".JPG </ PICTURE_PATH >
     </ITEM>
     <ITEM ...>
        .
	.
	.
       <PICTURE_PATH>"<REPORTID><NUM><COUNT>".JPG</ PICTURE_PATH >
     </ITEM>

</RESULT>

Remarks

All parameters are mandatory.

If an image is not requested, only the report attributes are returned.

The parameters “PictureRequest”, “width”, and “height” are relevant only to reports that have pictures.

Free-form reports that contain parameters are not supported by this service.

In Report Outputs, HAS_CHART="1" indicates that for this report a report image can be generated with the new tag PICTURE_PATH. The location of the tag depends on the report type. The template "<REPORTID><NUM><COUNT>".JPG will be used to store the image name, where:

• NUM: Incremented number of generated reports per session.
• COUNT: Count of inner reports that are included in the reports.

Sample Scenarios

Possible scenarios to generate request report data: