Developer's Guide
Table Of Contents
- Gateway Reporting Developer Guide
- Preface
- Reporting Overview
- Using the Reporting API
- Response Codes and Status Codes
- Reporting XML Schema
- Reporting Samples
- Running a Daily Activity Report
- Running a Transaction Summary Report
- Getting Results by Report ID
- Getting Metadata
- Getting Data
- Creating a Report Template
- Updating a Report Template
- Getting a Report Template
- Deleting a Report Template
- Creating a Schedule
- Getting a Schedule
- Updating a Schedule
- Deleting a Schedule
- Running a Transaction ID Search
- Running a Profile - Next Payment Date Report
- Running a Profile - Profile Modified Date Report
- Report Parameters
- Reports in This Appendix
- ACH Activity Summary Report
- ACH Batch ID Report
- ACH Detail Return Activity Report
- ACH Notification of Change Report
- ACH Return Activity Report
- ACH Settlement Report
- ACH Transaction Report
- Auto Credit Report
- Auto Delayed Capture Report
- Auto Resettle Report
- Auto Void Report
- Batch ID Report
- Custom Report
- Daily Activity Report
- Filter Scorecard Report
- Fraud Protection Report
- Payflow Link Orders Report
- PayPal Settlement Summary Report
- Profile Next Payment Report
- Profile Modified Date Report
- Recurring Billing Report
- Recurring Profile Failed Report
- Recurring Profile Report
- Settlement Report
- Shipping and Billing Report
- Transaction Summary Report
- Search Parameters
- Transaction ID Search
- Batch ID Search
- AccountNumberSearch
- CommentSearch
- AccountNumberRefSearch
- PurchaseOrderSearch
- RecurringBillingProfileIDSearch
- RecurringBillingProfileNameSearch
- RecurringBillingAccountNumberSearch
- RecurringBillingCommentSearch
- RecurringBillingAmountSearch
- FraudTransactionSearch
- OrderIDSearch
- PayPalTransactionIDSearch
- PayPalEmailSearch
- PayPalNameSearch
- Index
Gateway Reporting Developer Guide 49
Reporting Samples
Getting a Report Template
B
Getting a Report Template
This sample demonstrates how to retrieve a report template.
Getting 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>Partn er</partner>
<password>Pass word</password>
</authRequest>
<getTemplateRequest>
<templateName>My Template</templateName>
</getTemplateRequest>
</reportingEngineRequest>
Getting a Report Template 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>