QueryRange

Description

The QueryRange type allows you to limit the number of records returned in a query. The QueryRange type parameters are listed below.

Parameters

Name Type Description
startIndex integer This is the first record where the query should start.
fetchSize integer The fetchSize number is used to limit the number records that should be returned from the entire set of records in the totalCount.
totalCount integer The number of all the records in the query.

Usage

You can limit the number of reports returned in GetReports using QueryRange. For example, if GetReports returns 20 items without a QueryRange, you can set startIndex to 5 and fetchSize to 7 to return reports 5 through 12 in the list of available reports. You can also apply QueryRange in the RunReport call to limit the number of records returned via the fetchSize.

XML

The following XML snippet shows QueryRange as seen in a typical call.

<urn:queryRange>
    <urn:startIndex>5</urn:startIndex>
    <urn:fetchSize>7</urn:fetchSize>
    <urn:totalCount></urn:totalCount>
</urn:queryRange>