Developer's Guide

Reporting Developer’s 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>Partner</partner>
<password>Password</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>