Jump to: navigation, search

Manifest Section of a Report

Introduction

This page describes the format of the manifest section, which is part of every report. The manifest consists of the following sections:

<request-uri>

The <request-uri> section consists of the HTTP Request URI as received in its entirety by the Reporting Server.

<request-params>

The <request-params> section consists of the Request URI parameters in the Request URI which has been recognized as relevant for this request. This section does not display the HTTP Request URI parameters that are not known for this service.

<normalized-params>

The <normalized-params> section consists of recognized parameters in the Request URI which requires normalization. The only parameters requiring normalization right now are the DataTime parameters in a report requiring granularity (where granularity can be one of the values FIVE_MINUTES, THIRTY_MINUTES, HOUR, DAY, WEEK and MONTH). The normalization would change the DateTime values so that it lies on time unit boundaries for the granularity, and this section of the manifest describes the normalized parameter used in the report.

<pages>

The <pages> section indicates the current page number, the total number of pages, the total number of records satisfying this query, and the page-size used in the query. This section appears in the manifest if a query results in more than 1 page of CDRs.

<meta>

The <meta> section contains a list of <meta> elements, describing some information about this report.

Element Description
timezone_offset The number of hours of offset from GMT for the timezone of the Reporting Server used to generate the report.
dst_offset The number of hours of Daylight Saving Time offset of the Reporting Server used to generate the report.
version The version information of the Reporting Server used to generate the report.
generation_time The duration, in seconds, used to generate this particular report.

Example

The following is an example of the <manifest> section of a report:

<manifest>
   <request-uri><nowiki>http://172.24.133.108:8080/ems-rs/operations/arrivals/MCP?from=2010-05-03T10:03:23%2B05:30&granularity=DAY</nowiki></request-uri>
   <request-params>
     <from>2010-05-03T04:33:23Z</from> 
     <granularity>DAY</granularity> 
   </request-params>
   <normalized-params>
     <from>2010-05-02T18:30:00Z</from> 
     <to>2010-05-03T18:30:00Z</to> 
   </normalized-params>
   <meta name="timezone_offset" content="5.5" /> 
   <meta name="dst_offset" content="0.0" /> 
 </manifest>
This page was last edited on July 17, 2020, at 16:12.
Comments or questions about this documentation? Contact us for support!