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

Returning TextReportFormat Specified as "Line"

TextReportFormat specified as "Line" 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 line of the report requested. Each vector entry contains a string array with five entries; there is one vector entry for each line in the report for each of the following entries:
  • Text
  • Page Number
  • Line Number

    (Specifies the actual line number in the report and spans page boundaries.)

  • Line in Page

    (Specifies the line number on the page and is reset on each page.)

  • Carriage Control
• If the returnas value is "StringArray", there is a string array entry for each report. The string array entry is, in turn, another string array with an entry. For each line in the report, there is one string array entry.
• If the returnas value is "XMLString", then an XML-formatted string is returned. A <reportline> tag represents each report line. Within he <reportline></reportline> tags are the following tags:

  <reportdataline> Text

  <pagenumber> Page Number

  <linenumber> Line Number

  (Specifies the actual line number in the report and spans page boundaries).

  <pageline> Line in Page

  (Specifies the line number on the page and is reset on each page).

  <cc> Carriage Control

• If the returnas value is "XMLAttachment", it contains a file with the same data as returned by "XMLString".