Получение списка категорий
Запрос на получение списка всех категорий сотрудников партнера.
URL
GET https://rest.lksup.ru/v1/categories
Описание
Метод возвращает список всех категорий.
Для выполнения запроса необходимо предоставить: - Авторизационные данные — JWT access токен - Данные о странице — Данные для получения определенного списка заказов.
Примечание: Перед отправкой убедитесь, что тело запроса зашифровано корректно.
Структура запроса
В HTTP Header необходимо передать x-nonce, также в заголовок Authorization, помещается JWT токен. - Данные о пагинации. - X-Nonce: — значение состоит из случайных символов, используется в шифровании (передается в заголовке)
Пример запроса:
Формат запроса:
GET https://rest.lksup.ru/v1/categories
Тело запроса:
{
"page": integer,
"per_page": integer
}
Параметры запроса
| Параметр | Тип | Описание | Обязательный | Шифрование |
|---|---|---|---|---|
page |
integer | Номер получаемой страницы (значение по умолчанию = 1) | Нет | Да |
per_page |
integer | Количество записей на странице (значение по умолчанию = 15) | Нет | Да |
Структура ответа
Пример успешного ответа - код 200
{
"data": [{
"idCategory": b52c4d84-e0ec-4941-a3ea-8110efc62f32,
"nameCategory": "Секретари" }
]
}
Параметры успешного ответа
| Параметр | Тип | Описание |
|---|---|---|
idCategory |
uuid | Идентификатор категорий |
nameCategory |
string | Наименование категории |
Пример ответа с ошибкой 4xx:
{
"success": false;
"message": "string"
}
Возможные ошибки
| Статус | Описание |
|---|---|
| 401 | Не авторизован. Некорректный токен |
| 404 | Категории не найдены |
| 422 | Передано некорректное значени |