Samples
DocsCurrentLast updated: June 14th 2022, @ 9:20:42 am
Note: In this section, replace these values shown in boldface with appropriate values:
<User>,<Vendor>,<Partner>, and<Password>.
- Run a daily activity report
- Run a transaction summary report
- Get results by report ID
- Get metadata
- Get data
- Create a report template
- Update a report template
- Get a report template
- Delete a report template
- Create a schedule
- Get a schedule
- Update a schedule
- Delete a schedule
- Run a transaction ID search
- Run a profile - Next payment date report
- Run a profile - Profile modified date Report
Run a daily activity report
Request
This request demonstrates how to run a Daily Activity Report with a page size of 50 lines to obtain results for September 7, 2014.
<?xml version="1.0" encoding="UTF-8"?> <reportingEngineRequest> <authRequest> <user>User</user> <vendor>Vendor</vendor> <partner>Partner</partner> <password>Password</password> </authRequest> <runReportRequest> <reportName>DailyActivityReport</reportName> <reportParam> <paramName>report_date</paramName> <paramValue>2014-09-07</paramValue> </reportParam> <pageSize>50</pageSize> </runReportRequest> </reportingEngineRequest>
Response
In the response to running the Daily Activity Report, the responseCode of 100 indicates that the report completed successfully. The reportId 132 returned is used to uniquely identify this report in future calls to the Reporting API.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
<runReportResponse>
<reportId>132</reportId>
<statusCode>3</statusCode>
<statusMsg>Report has completed successfully</statusMsg>
</runReportResponse>
</reportingEngineResponse>
Run a transaction summary report
Request
The request demonstrates how to run a Transaction Summary Report with a page size of 50 lines starting on October 13 at 12:00AM and ending on October 15 at 12:59 and 59 seconds PM.
<?xml version="1.0" encoding="UTF-8"?> <reportingEngineRequest> <authRequest> <user>User</user> <vendor>Vendor</vendor> <partner>Partner</partner> <password>Password</password> </authRequest> <runReportRequest> <reportName>TransactionSummaryReport</reportName> <reportParam> <paramName>start_date</paramName> <paramValue>2020-10-13</paramValue> </reportParam> <reportParam> <paramName>end_date</paramName> <paramValue>2020-10-15</paramValue> </reportParam> <pageSize>50</pageSize> </runReportRequest> </reportingEngineRequest>
Response
In the response to running the Transaction Summary Report, the response code of 100 indicates that the request completed successfully. The status code of 3 indicates that the report completed successfully and the reportId 131 is returned for future reverence in calls inquiring about this report.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
<runReportResponse>
<reportId>133</reportId>
<statusCode>3</statusCode>
<statusMsg>Report has completed successfully</statusMsg>
</runReportResponse>
</reportingEngineResponse>
Get results by report ID
Request
In the request to get the results by report ID, reportId 131 specifies the report for which results are being requested. The reportId 131 was returned in a previous call to run the report.
<?xml version="1.0" encoding="UTF-8"?> <reportingEngineRequest> <authRequest> <user>User</user> <vendor>Vendor</vendor> <partner>Partner</partner> <password>Password</password> </authRequest> <getResultsRequest> <reportId>131</reportId> </getResultsRequest> </reportingEngineRequest>
Response
In the response to getting results by report ID, the response code of 100 indicates that the request completed successfully. The status code of 3 indicates that the report with reportId 131 completed successfully.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
<getResultsResponse>
<Results>
<reportId>131</reportId>
<statusCode>3</statusCode>
<statusMsg>Report has completed successfully</statusMsg>
</Results>
</getResultsResponse>
</reportingEngineResponse>
Get metadata
Request
The request demonstrates how to obtain the formatting information for the report with reportId 131.
<?xml version="1.0" encoding="UTF-8"?> <reportingEngineRequest> <authRequest> <user>User</user> <vendor>Vendor</vendor> <partner>Partner</partner> <password>Password</password> </authRequest> <getMetaDataRequest> <reportId>131</reportId> </getMetaDataRequest> </reportingEngineRequest>
Response
In the response to retrieving metadata, the response code of 100 indicates that the request completed successfully. The response returns the number columns, rows, pages, and lines per page are present in the format of the report with reportID 131. For each table column, the response returns the column heading.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
<getMetaDataResponse>
<numberOfRows>13</numberOfRows>
<numberOfPages>1</numberOfPages>
<pageSize>50</pageSize>
<numberOfColumns>11</numberOfColumns>
<columnMetaData>
<dataName>Transaction ID</dataName>
<dataType>string</dataType>
</columnMetaData>
<columnMetaData>
<dataName>Trans Time</dataName>
<dataType>date</dataType>
</columnMetaData>
<columnMetaData>
<dataName>Trans Type</dataName>
<dataType>string</dataType>
</columnMetaData>
<columnMetaData>
<dataName>Tender Type</dataName>
<dataType>string</dataType>
</columnMetaData>
<columnMetaData>
<dataName>Account Number</dataName>
<dataType>string</dataType>
</columnMetaData>
<columnMetaData>
<dataName>Expires</dataName>
<dataType>string</dataType>
</columnMetaData>
<columnMetaData>
<dataName>Amount</dataName>
<dataType>string</dataType>
</columnMetaData>
<columnMetaData>
<dataName>Result</dataName>
<dataType>number</dataType>
</columnMetaData>
<columnMetaData>
<dataName>Reponse Msg</dataName>
<dataType>string</dataType>
</columnMetaData>
<columnMetaData>
<dataName>Comment1</dataName>
<dataType>string</dataType>
</columnMetaData>
<columnMetaData>
<dataName>Comment2</dataName>
<dataType>string</dataType>
</columnMetaData>
</getMetaDataResponse>
</reportingEngineResponse>
The format returned by this sample is:
Note The last four digits of the account number are returned.| Transaction ID | Trans Time | Trans Type | Tender Type | Account Number | Expires | Amount | Result | Response Msg | Comment1 | Comment2 |
|---|---|---|---|---|---|---|---|---|---|---|
| V89A0A000087 | 2014-09-07 17:45:07 | S | O | 1111 | 01/15 | A1000 | O | Approved | ||
| V89A0A000088 | 2014-09-07 17:45:09 | S | O | 1111 | 01/07 | A1000 | O | Approved | ||
| V89A0A000089 | 2014-09-07 17:48:20 | S | O | 1111 | 01/07 | A1000 | O | Approved | ||
| V89A0A00008A | 2014-09-07 17:52:03 | S | O | 1111 | 01/07 | A1000 | O | Approved | ||
| V89A0A00008B | 2014-09-07 17:53:07 | S | O | 1111 | 01/07 | A1000 | O | Approved | ||
| V89A0A00008C | 2014-09-07 17:53:32 | S | O | 1111 | 01/07 | A1000 | O | Approved | ||
| V89A0A00008D | 2014-09-07 17:54:20 | S | O | 1111 | 01/07 | A1000 | O | Approved | ||
| V89A0A00008E | 2014-09-07 17:56:02 | S | O | 1111 | 01/07 | A1000 | O | Approved | ||
| V89A0A00008F | 2014-09-07 17:56:33 | S | O | 1111 | 01/07 | A1000 | O | Approved | ||
| V89A0A000090 | 2014-09-07 18:01:31 | S | O | 1111 | 01/07 | A1000 | O | Approved | ||
| V89A0A000091 | 2014-09-07 18:01:44 | S | O | 1111 | 01/07 | A1000 | O | Approved | ||
| V89A0A000092 | 2014-09-07 18:02:19 | S | O | 1111 | 01/07 | A1000 | O | Approved | ||
| V89A0A000093 | 2014-09-07 18:03:09 | S | O | 1111 | 01/07 | A1000 | O | Approved |
Get data
Request
In the request to retrieve data, reportId 131 specifies the report for which the data is being requested. The reportId value of 131 was returned in a previous call to run the report. The pageNum refers to the page number desired in a multi-page report.
<?xml version="1.0" encoding="UTF-8"?> <reportingEngineRequest> <authRequest> <user>User</user> <vendor>Vendor</vendor> <partner>Partner</partner> <password>Password</password> </authRequest> <getDataRequest> <reportId>131</reportId> <pageNum>1</pageNum> </getDataRequest> </reportingEngineRequest>
Response
In the response to retrieving data, the response code of 100 indicates that the request completed successfully. The response returns the data in each of the columns and rows of the report with reportID 131.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
<getDataResponse>
<reportDataRow>
<columnData>
<data>V89A0A000087</data>
</columnData>
<columnData>
<data>2014-09-07 17:45:08</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>01/07</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A000088</data>
</columnData>
<columnData>
<data>2014-09-07 17:46:09</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>01/15</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A000089</data>
</columnData>
<columnData>
<data>2014-09-07 17:48:20</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>01/15</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A00008A</data>
</columnData>
<columnData>
<data>2014-09-07 17:52:03</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>01/15</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A00008B</data>
</columnData>
<columnData>
<data>2014-09-07 17:53:07</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>01/15</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A00008C</data>
</columnData>
<columnData>
<data>2014-09-07 17:53:32</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>01/15</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
columnData>
data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A00008D</data>
</columnData>
<columnData>
<data>2014-09-07 17:54:20</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>01/07</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A00008E</data>
</columnData>
<columnData>
<data>2014-09-07 17:56:02</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>01/15</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A00008F</data>
</columnData>
<columnData>
<data>2014-09-07 17:56:33</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>01/15</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A000090</data>
</columnData>
<columnData>
<data>2014-09-07 18:01:31</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columndata>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>01/15</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
<columnData>
<data>24</data>
</columnData>
<columnData>
<data>Unknown error</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A000091</data>
</columnData>
<columnData>
<data>2014-09-07 18:01:44</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>12/15</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A000092</data>
</columnData>
<columnData>
<data>2014-09-07 18:02:19</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>12/15</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A000093</data>
</columnData>
<columnData>
<data>2014-09-07 18:03:09</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>12/15</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<pageNum>1</pageNum>
</getDataResponse>
</reportingEngineResponse>
Response
The data is returned in the following tabular format of 13 rows and 11 columns:
| Transaction ID | Trans Time | Trans Type | Tender Type | Account Number | Expires | Amount | Result | Response Msg | Comment1 | Comment2 |
|---|---|---|---|---|---|---|---|---|---|---|
| V89A0A000087 | 2014-09-07 17:45:07 | S | O | 1111 | 01/15 | A1000 | O | Approved | ||
| V89A0A000088 | 2014-09-07 17:45:09 | S | O | 1111 | 01/07 | A1000 | O | Approved | ||
| V89A0A000089 | 2014-09-07 17:48:20 | S | O | 1111 | 01/07 | A1000 | O | Approved | ||
| V89A0A00008A | 2014-09-07 17:52:03 | S | O | 1111 | 01/07 | A1000 | O | Approved | ||
| V89A0A00008B | 2014-09-07 17:53:07 | S | O | 1111 | 01/07 | A1000 | O | Approved | ||
| V89A0A00008C | 2014-09-07 17:53:32 | S | O | 1111 | 01/07 | A1000 | O | Approved | ||
| V89A0A00008D | 2014-09-07 17:54:20 | S | O | 1111 | 01/07 | A1000 | O | Approved | ||
| V89A0A00008E | 2014-09-07 17:56:02 | S | O | 1111 | 01/07 | A1000 | O | Approved | ||
| V89A0A00008F | 2014-09-07 17:56:33 | S | O | 1111 | 01/07 | A1000 | O | Approved | ||
| V89A0A000090 | 2014-09-07 18:01:31 | S | O | 1111 | 01/07 | A1000 | O | Approved | ||
| V89A0A000091 | 2014-09-07 18:01:44 | S | O | 1111 | 01/07 | A1000 | O | Approved | ||
| V89A0A000092 | 2014-09-07 18:02:19 | S | O | 1111 | 01/07 | A1000 | O | Approved | ||
| V89A0A000093 | 2014-09-07 18:03:09 | S | O | 1111 | 01/07 | A1000 | O | Approved |
Create a report template
Request
This request creates a report template from a Daily Activity Report with a report template name of ‘MyTemplate’. It sets the values of two parameters (name1 and name2). The parameter names and values are stored in the database.
<?xml version="1.0" encoding="UTF-8"?> <reportingEngineRequest> authRequest> <user>User</user> <vendor>Vendor</vendor> <partner>Partner</partner> <password>Password</password> </authRequest> <createTemplateRequest> <templateDefinition> <templateName>My Template</templateName> <reportName>DailyActivityReport</reportName> <reportParam> <paramName>name1</paramName> <paramValue>value1</paramValue> </reportParam> <reportParam> <paramName>name2</paramName> <paramValue>value2</paramValue> </reportParam> </templateDefinition> </createTemplateRequest> </reportingEngineRequest>
Response
In the response to creating a report template, the response code of 100 indicates that the request completed successfully. Thereafter, when ‘My Template’ is run, these parameters are automatically retrieved from the database and used to generate the Daily Activity Report.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
</reportingEngineResponse>
Update a report template
Request
The request specifies the report template to update by its name ‘My Template’ and the report type (Daily Activity Report) upon which it was originally based.Updating a report template is not an additive process. It replaces the parameters and values previously defined for ‘My Template’ with new parameters and values.
<?xml version="1.0" encoding="UTF-8"?> <reportingEngineRequest> <authRequest> <user>User</user> <vendor>Vendor</vendor> <partner>Partner</partner> <password>Password</password> </authRequest> <updateTemplateRequest> <templateDefinition> <templateName>My Template</templateName> <reportName>DailyActivityReport</reportName> <reportParam> <paramName>name3</paramName> <paramValue>value3</paramValue> </reportParam> <reportParam> <paramName>name4</paramName> <paramValue>value4</paramValue> </reportParam> </templateDefinition> </updateTemplateRequest> </reportingEngineRequest>
Response
In the response to updating a report template, the response code of 100 indicates that the request completed successfully. The getTemplateRequest can be used to check the new parameters and values.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
</reportingEngineResponse>
Get a report template
Request
The request specifies the report template name ‘My Template’ to retrieve.
<?xml version="1.0" encoding="UTF-8"?> <reportingEngineRequest> <authRequest> <user>User</user> <vendor>Vendor</vendor> <partner>Partner</partner> <password>Password</password> </authRequest> <getTemplateRequest> <templateName>My Template</templateName> </getTemplateRequest> </reportingEngineRequest>
Response
In the response to retrieving a report template, the response code of 100 indicates that the request completed successfully. The response returns the report template name, the report type (Daily Activity Report) upon which it was originally based, as well as the parameter names and values defined for this report template.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
<getTemplateResponse>
<templateDefinition>
<templateName>My Template</templateName>
<reportName>DailyActivityReport</reportName>
<reportParam>
<paramName>name3</paramName>
<paramValue>value3</paramValue>
</reportParam>
<reportParam>
<paramName>name4</paramName>
<paramValue>value4</paramValue>
</reportParam>
</templateDefinition>
</getTemplateResponse>
</reportingEngineResponse>
Delete a report template
Request
The request to delete a report template includes the templateName ‘My Template’.
<?xml version="1.0" encoding="UTF-8"?> <reportingEngineRequest> <authRequest> <user>User</user> <vendor>Vendor</vendor> <partner>Partner</partner> <password>Password</password> </authRequest> <deleteTemplateRequest> <templateName>My Template</templateName> </deleteTemplateRequest> </reportingEngineRequest>
Response
In the response to deleting a report template, the response code of 100 indicates that the request completed successfully. If you were to specify a bogus name for the report template (in error), the responseCode 113 is returned with the responseMsg “Unknown template requested”.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>113</responseCode>
<responseMsg>Unknown template requested</responseMsg>
</baseResponse>
</reportingEngineResponse>
Create a schedule
Request
<?xml version="1.0" encoding="UTF-8"?> <reportingEngineRequest> <authRequest> <user>User</user> <vendor>Vendor</vendor> <partner>Partner</partner> <password>Password</password> </authRequest> <createScheduleRequest> <scheduleDefinition> <scheduleName>My Schedule</scheduleName> <templateName>My Template</templateName> <notificationRequired>false</notificationRequired> <daily></daily> </scheduleDefinition> </createScheduleRequest> </reportingEngineRequest>
Response
In the response to creating a schedule, the response code of 100 indicates that the request completed successfully.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
</reportingEngineResponse>
Get a schedule
Request
<?xml version="1.0" encoding="UTF-8"?> <reportingEngineRequest> <authRequest> <user>User</user> <vendor>Vendor</vendor> <partner>Partner</partner> <password>Password</password> </authRequest> <getScheduleRequest> <scheduleName>My Schedule</scheduleName> </getScheduleRequest> </reportingEngineRequest>
Response
In the response to getting a schedule, the response code of 100 indicates that the request completed successfully. The response returns the name of the schedule, the report template scheduled, and the schedule (daily).
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
<getScheduleResponse>
<scheduleDefinition>
<scheduleName>My Schedule</scheduleName>
<templateName>My Template</templateName>
<notificationRequired>false</notificationRequired>
<daily></daily>
</scheduleDefinition>
</getScheduleResponse>
</reportingEngineResponse>
Update a schedule
Request
<?xml version="1.0" encoding="UTF-8"?> <reportingEngineRequest> <authRequest> <user>User</user> <vendor>Vendor</vendor> <partner>Partner</partner> <password>Password</password> </authRequest> <updateScheduleRequest> <scheduleDefinition> <scheduleName>My Schedule</scheduleName> <templateName>My Template</templateName> <notificationRequired>false</notificationRequired> <daily/> </scheduleDefinition> </updateScheduleRequest> </reportingEngineRequest>
Response
In the response to updating a schedule, the response code of 100 indicates that the request completed successfully.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
</reportingEngineResponse>
Delete a schedule
Request
<?xml version="1.0" encoding="UTF-8"?> <reportingEngineRequest> <authRequest> <user>User</user> <vendor>Vendor</vendor> <partner>Partner</partner> <password>Password</password> </authRequest> <deleteScheduleRequest> <scheduleName>My Schedule</scheduleName> </deleteScheduleRequest> </reportingEngineRequest>
Response
In the response to deleting a schedule, the response code of 100 indicates that the request completed successfully.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
</reportingEngineResponse>
Run a transaction ID search
Request
<?xml version="1.0" encoding="UTF-8"?> <reportingEngineRequest> <authRequest> <user>User</user> <vendor>Vendor</vendor> <partner>Partner</partner> <password>Password</password> </authRequest> <runSearchRequest> <searchName>TransactionIDSearch</searchName> <reportParam> <paramName>transaction_id</paramName> <paramValue>V89A0A000264</paramValue> </reportParam> <pageSize>50</pageSize> </runSearchRequest> </reportingEngineRequest>
Response
In the response to running the transaction ID search, the responseCode of 100 indicates that the report completed successfully. The reportId 132 returned is used to uniquely identify this report in future calls to the Reporting API.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
<runSearchResponse>
<reportId>132</reportId>
<statusCode>3</statusCode>
<statusMsg>Report has completed successfully</statusMsg>
</runSearchResponse>
</reportingEngineResponse>
Run a profile - Next payment date report
Request
<?xml version="1.0" encoding="UTF-8"?> <reportingEngineRequest> <authRequest> <user>User</user> <vendor>Vendor</vendor> <partner>Partner</partner> <password>Password</password> </authRequest> <runReportRequest> <reportName>RBProfileNPDReport</reportName> <reportParam> <paramName>start_date</paramName> <paramValue>2014-06-22 00:00:00</paramValue> </reportParam> <reportParam> <paramName>end_date</paramName> <paramValue>2015-08-30 00:00:00</paramValue> </reportParam> <pageSize>50</pageSize> </runReportRequest> </reportingEngineRequest>
Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
<runReportResponse>
<reportId>132</reportId>
<statusCode>3</statusCode>
<statusMsg>Report has completed successfully</statusMsg>
</runReportResponse>
</reportingEngineResponse>
Run a profile - Profile modified date report
Request
<?xml version="1.0" encoding="UTF-8"?> <reportingEngineRequest> <authRequest> <user>User</user> <vendor>Vendor</vendor> <partner>Partner</partner> <password>Password</password> </authRequest> <runReportRequest> <reportName>RBProfilePMDReport</reportName> <reportParam> <paramName>start_date</paramName> <paramValue>2013-06-22 00:00:00</paramValue> </reportParam> <reportParam> <paramName>end_date</paramName> <paramValue>2013-08-30 00:00:00</paramValue> </reportParam> <pageSize>50</pageSize> </runReportRequest> </reportingEngineRequest>
Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
<runReportResponse>
<reportId>132</reportId>
<statusCode>3</statusCode>
<statusMsg>Report has completed successfully</statusMsg>
</runReportResponse>
</reportingEngineResponse>