PagingResultMeta

data class PagingResultMeta(val numberOfRecords: Int?, val limit: Int?, val offset: Int?, val page: Int?)

Data class containing paging information regarding the returned records, when response is paginated. The input for paginated query contains two parameters:

  • limit - Тhe number of records to return. Defaults to 10 and maximum is 50.

  • offset - Тhe starting position of the response, where 0 is the first record. Default = 0.

The total number of records is not returned, to prevent queries spanning on all records. If numberOfRecords is smaller than 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 by limit.

Constructors

Link copied to clipboard
constructor(numberOfRecords: Int?, limit: Int?, offset: Int?, page: Int?)

Properties

Link copied to clipboard
val limit: Int?

The requested number of records to be returned per page.

Link copied to clipboard

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

Link copied to clipboard
val offset: Int?

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

Link copied to clipboard
val page: Int?

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