PagingContext Entity

The paging context identifies paging information on REST APIs that support paged requests and responses. This allows us to provide a unified paging implementation across all our APIs that require paging.

Sample PagingContext XML

<PagingContext> <ItemsPerPage>10</ItemsPerPage> <StartItem>0</StartItem> <TotalItems>1593</TotalItems> </PagingContext>

PagingContext Attributes

Attribute	Type	Description
StartItem	int	Identifies the first item fetched in the response. This will be the exact same value that you passed to the API in the request.
ItemsPerPage	int	Identifies how large each of your pages are. The result list will be restricted to no more than this number of items. This will be the exact same value that you passed to the API in the request.
TotalItems	int	Given the exact query you made to the API, this contains the total number of items that match the query. Using this and ItemsPerPage you can calculate the total number of pages you'd need to render the complete result list.