Paging of results

Paging is used to split large amounts of records in fast batches, or pages. With the paging option we set the number of results per call and set the page to show.

<Paging>
        <Limit>20</Limit>
        <StartPage>Page1</StartPage>
</Paging>

Limit

Defines the maximum result set. The default is 10.

StartPage

The start of the result set. This value is returned in the previous result in NextPage. The default, when not specified, is the first result. You can reuse the Paging object returned as result to retrieve the next batch of results. This value may looks like a integer but is defined as a string because it is a paging token.

Example

Request

<Paging>
        <Limit>10</Limit>
        <StartPage>Page2</StartPage>
</Paging>

Response

<PagingResponse>
    <NextPage>Page3</NextPage>
</PagingResponse>

 

Was this article helpful?