Developer's Guide

Reporting Developer’s Guide 15
Using the Reporting API
Using Report Templates
2
The response to creating a report template returns a respCode and respMsg.
Step 2. Update a report template
To update a report template, call the updateTemplateRequest with the following
parameters.
updateTemplateRequest(templateName, reportParams)
The response to updating a report template returns a respCode and respMsg.
N OTE: Updating a report template is not incremental. It only sets values for the parameters
that are passed to updateTemplateRequest.
Step 3. Delete a report template
To delete a report template, call deleteTemplateRequest, providing the
templateName as the input parameter.
deleteTemplateRequest(templateName)
The response to deleting a report template returns a respCode and respMsg.
Using Report Templates
Report templates are run like any standard report. They can also be scheduled to run on a daily,
weekly, or monthly basis. Finally, report template schedules can be updated or deleted.
Running a report template and obtaining the report template data
Step 1. Run a report template
To run a report template, call runReportRequest with the following parameters.
runReportRequest(templateName, reportParams, pageSize).
reportParam(s) paramName and paramValue of each reportParam to be assigned a
value.
templateName Name given to the report template when it was created.
reportParam(s) paramName and paramValue of each reportParam to be
assigned a value.
templateName Name given to the report template when it was created.