Understanding the Web Services › The Report Data Web Service › Data Returned by the Report Data Web Service › Returning TextReportFormat Specified as "Page"

Returning TextReportFormat Specified as "Page"

TextReportFormat specified as "Page" can have returnas values of "Vector", "StringArray", "XMLString" or "XMLAttachment":

• If the returnas value is "Vector", there is an entry in the vector for each page and each line of the report. Each vector entry contains a two-entry string array.
  • The first entry in the string array indicates whether the entry is for a page (has constant of "page") or a line (has a constant of "line").
  • If the first entry in the string array is for a page, the second entry is the page number.
  • If the first entry in the string array is for a line, the second entry is the report line.
  • If the first entry is "/page" or the end of the vector has occurred, then the page has ended.
• If the returnas value is "StringArray", there is a string array entry for each report. Each string array entry contains another two-entry string array.
  • The first entry in the string array indicates whether the entry is for a page (has constant of "page") or a line (has a constant of "line").
  • If the first entry in the string array is for a page, the second entry is the page number.
  • If the first entry in the string array is for a line, the second entry is the report line.
  • If the first entry is "/page" or the end of the vector has occurred, then the page has ended.
• If the returnas value is "XMLString", then an XML-formatted string is returned. Pages are designated by a <Page> tag and lines are designated within the page with a <Line> tag. The XML String includes entries for all pages that are requested through the input request parameters.
• If the returnas value is "XMLAttachment", it contains a file with the same data that is returned by "XMLString".