PayPal Gateway - 2013 Guía de usuario descargar pdf (Pagina 16)

Using the Reporting API

Managing Report Templates

16 Gateway Reporting Developer Guide

Data is returned for the report page specified by pageNum. To obtain the data in a multi-page

report, you must call getDataRequest for each report page.

Running Reports Offline

When a report takes longer to run than the time allotted, it is taken offline and status code 2,

“Report is currently executing,” is returned. You must check for the results at a later time.

Step 1. Run the report

Request to run a report by calling runReportRequest. See “Step 1. Run the report” on

page 15.

The report times out. The ReportId and status code 2 are returned.

Step 2. Get the report results later

It is your responsibility to obtain the report results at a later time. Call

getResultsRequest, providing the reportId as a parameter.

getResultsRequest(reportId)

getResultsResponse returns a statusCode and statusMsg. Call

getResultsResponse in a loop until statusCode 3, “Report has completed

successfully,” is returned.

Step 3. Get the metadata

Request to get the report’s metadata by calling getMetaDataRequest. See “Step 2. Get

the metadata” on page 15.

Step 3. Get the report data

Request to get the report data by calling getDataRequest. See “Step 3. Get the report

data” on page 15.

Managing Report Templates

Using the Reporting API, you can create, update, and delete report templates.

Step 1. Create a report template

To create a report template, call createTemplateRequest with the following parameters.

createTemplateRequest (templateName, reportName,

reportParams)

Parameter Description

templateName Name that you are giving to the report template.

reportName Standard report from which you are creating the report template.

1 2 ... 11 12 13 14 15 16 17 18 19 20 21 ... 123 124

Sin comentarios

PayPal Gateway - 2013 Guía de usuario Pagina 16