PaginationOutput
This type defines the paginationOutput container. The paginationOutput container consists of fields that indicate the total number of pages and cases that match the input criteria, the number of cases per page, and the current page number being viewed. See the corresponding field descriptions for more information on the child elements of paginationOutput.
Type that uses PaginationOutput:
Call that uses PaginationOutput:
Fields
The number of cases returned per page. This value is set in the paginationInput.entriesPerPage field in the getUserCases request.
See the Field Index to learn which calls use entriesPerPage.
The page number currently being viewed. The total number of result pages is shown in the totalPages field. If totalPages is more than 1, multiple getUserCases calls must be made to view all case results, with the paginationInput.pageNumber value being incremented by 1 in each subsequent call.
See the Field Index to learn which calls use pageNumber.
This value indicates the total number of cases that exist based on the current input criteria. Once this value is known, the caller may want to considering tweaking the paginationInput fields and making another call.
See the Field Index to learn which calls use totalEntries.
This value indicates the total number of result pages that exist based on the current input criteria, including the paginationInput fields. If totalPages is more than 1, multiple getUserCases calls must be made to view all case results, with the paginationInput.pageNumber value being incremented by 1 in each subsequent call.
See the Field Index to learn which calls use totalPages.