Developer's Guide

Using the Reporting API
Where to Go For More Information on the APIs
2
12 Gateway Reporting Developer Guide
Response Data
Responses include the following information:
 All responses return a base response consisting of a response code (responseCode) and
a response message (responseMsg).
 Most responses return applicable response parameter data.
 Some responses return a status code (statusCode) and a status message
(statusMsg).
Where to Go For More Information on the APIs
To understand how the XML API is coded, look at the request notation along with the XML
schema, samples, and report parameters in this guide. See the following sources for details:
Running Reports
You can run reports and obtain the report data right away. If, however, running a report takes
more than the time allotted, the report is run offline, and you must periodically check for the
report data.
Source Contents
Chapter 3,
“Response Codes
and Status Codes”
Lists all response codes, status codes, and their message strings.
Appendix A Contains the XML schema.
Appendix B Provides API request and response samples for each request and
response referred to in this chapter.
Appendix C Describes the input and output parameters for all standard (predefined)
reports supported.
Appendix D Describes the input and output parameters for all report searches
supported.