Interface PagingResultMeta

Contains paging information regarding the returned records, when response is paginated.

The input for paginated query contains two parameters:

  • limit - This is the requested number of records to return. Defaults to 10 and maximum is 50.
  • offset - This is the requested starting position of the response, where 0 is the first record. Default = 0.

Note! The total number of records is not returned, to prevent queries spanning on all records. If numberOfRecords < limit, this means no further pages are available. On request of offset beyond the last record, the returned numberOfRecords is 0.

The number of previous pages can be calculated by dividing offset to limit.

interface PagingResultMeta {
    limit?: number;
    numberOfRecords?: number;
    offset?: number;
    page?: number;
}

Properties

limit? numberOfRecords? offset? page?

Properties

Optional limit

limit?: number

This is the requested number of records to be returned per page.

Optional numberOfRecords

numberOfRecords?: number

This is the number of records returned in the lookup. Always numberOfRecords is smaller than or equal to limit.

Optional offset

offset?: number

This is the requested starting position of the response, where 0 is the first record.

Optional page

page?: number

This is the page of records on which the lookup starts. The starting page is 1.

Settings

Member Visibility

Theme

On This Page

limitnumberOfRecordsoffsetpage