B2BB2CH2H

Пагинация

Пагинация - разделение ответа на несколько страниц. Механизм пагинации может быть использован в REST-запросах GET.

Параметры запроса

QUERY
Атрибут
Описание
limit
numberoptional

Количество объектов на одной странице. Значение по умолчанию: 1000. Максимальное значение: 1000

offset
numberoptional

Количество объектов в списке, которые необходимо пропустить. Значение по умолчанию: 0

Пример запроса
1curl -X GET '{host}/claims?limit=5&offset=5'
2  -H 'Content-Type: application/json'

Параметры ответа

Пример ответа 200 (OK)
1{
2  "pagination": {
3      "limit": 10,
4      "offset": 45,
5      "totalCount": 100
6    },
7  "items": [..] //результаты в виде массива
8}
objectoptional

Данные пагинации

limit
numberoptional

Количество объектов на одной странице

offset
numberoptional

Количество объектов в списке, которые необходимо пропустить

totalCount
numberoptional

Общее количество записей

items
array of subjectoptional

Массив объектов результата

Пример ответа 200 (OK)
1{
2  "pagination": {
3      "limit": 10,
4      "offset": 45,
5      "totalCount": 100
6    },
7  "items": [..] //результаты в виде массива
8}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_request - неверные входные параметры запроса

error_description
stringoptional

Описание ошибки

Пример ошибки 400 (Bad Request)
1{
2"error":"invalid_request",
3"error_description":"parameter "limit" is not valid."
4}

Алгоритм работы пагинации

Пример 1: Если клиент запрашивает limit = 100, offset = 0, то клиенту вернётся с 1-ой по 100-ую запись.

Пример 2: Если клиент запрашивает limit = 100, offset = 1000, то клиенту вернётся с 1001-ой по 1100-ую запись.

Сортировка в пагинации происходит следующим образом: вверху списка возвращаются новые записи, внизу - старые записи.