Пагинация - разделение ответа на несколько страниц. Механизм пагинации может быть использован в REST-запросах GET.
Параметры запроса
Количество объектов на одной странице. Значение по умолчанию: 1000. Максимальное значение 1000
Количество объектов в списке, которые необходимо пропустить. Значение по умолчанию: 0
curl -X GET '{host}/claims?limit=5&offset=5'
-H 'Content-Type: application/json'
Параметры ответа
{
"pagination": {
"limit": 10,
"offset": 45,
"totalCount": 100
},
"items": [..] //результаты в виде массива
}
Количество объектов на одной странице
Количество объектов в списке, которые необходимо пропустить
Общее количество записей
Массив объектов результата
{
"pagination": {
"limit": 10,
"offset": 45,
"totalCount": 100
},
"items": [..] //результаты в виде массива
}
Код ошибки. Принимает возможные значения: invalid_request
- Неверные входные параметры запроса
Описание ошибки
{
"error":"invalid_request",
"error_description":"parameter "limit" is not valid."
}
Алгоритм работы пагинации
Пример 1: Если клиент запрашивает limit = 100, offset = 0, то клиенту вернется с 1-ой по 100-ую запись.
Пример 2: Если клиент запрашивает limit = 100, offset = 1000, то клиенту вернется с 1001-ой по 1100-ую запись.
Сортировка в пагинации происходит следующим образом: вверху списка возвращаются новые записи, внизу - старые записи.