PaginationOutput
Type defining the paginationOutput container, which consists of fields that indicate the total number of pages and returns that match the input criteria, the number of returns per page, and the current page number being viewed.
Type that uses PaginationOutput:
Call that uses PaginationOutput:
Fields
This integer value indicates the maximum number of returns to return in a single "page" of data. This value, along with the number of returns that match the input criteria, determines the total pages (see paginationOutput.totalPages) in the result set.
See the Field Index to learn which calls use entriesPerPage.
This integer value indicate the "page" number of the results set. The total number of result pages is determined by the total number of returns (returned in paginationOutput.totalEntries) matching the request criteria divided by the number of returns to display per page of data (indicated in paginationOutput.entriesPerPage). If there are multiple pages of returns (see paginationOutput.totalPages) to view, multiple getUserReturns calls can be made to view all returns, and the paginationInput.pageNumber value can be incremented by 1 in each subsequent call.
See the Field Index to learn which calls use pageNumber.
This value indicates the total number of returns that exist based on the current input criteria. Once this value is known, the caller may want to considering tweaking the paginationInput fields in the getUserReturns request 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 getUserReturns calls must be made to view all result pages, with the paginationInput.pageNumber value being incremented by 1 in each subsequent call.
See the Field Index to learn which calls use totalPages.