ReportRequest Data Object
Defines the base object for all report requests.
<xs:complexType name="ReportRequest"> <xs:sequence> <xs:element minOccurs="0" name="Format" nillable="true" type="tns:ReportFormat" /> <xs:element minOccurs="0" name="Language" nillable="true" type="tns:ReportLanguage" /> <xs:element minOccurs="0" name="ReportName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="ReturnOnlyCompleteData" nillable="true" type="xs:boolean" /> </xs:sequence> </xs:complexType>
The format of the report data. For example, you can request the data in comma-separated values (CSV) format or XML format. The default is CSV format.
All files are compressed (zipped).
The language to use to generate the report headers and columns. The default is English.
The name of the report. The name is included in the report header. If you do not specify a report name, the system generates a name in the form, ReportType-ReportDateTime.
Determines whether you want the service to generate the report only if all the data has been processed and is available.
If true, the request fails if the system has not finished processing all the data based on the aggregation, scope, and time period values that you specify. However, if false, the request succeeds but the report will contain only the data that the system has finished processing at the time of the request (there is no indication as to whether the data is complete). The default is false.
Because you cannot retrieve complete data for today, you must set this element to false if the end date of the custom date range specified in the Time element of the derived report object is set to today or the Time element contains one of the following predefined time values:
Do not instantiate this object. Instead, you may instantiate one of the following report request objects which derives from this object to request a report.