Результат изменения настроек (лимитов) карт
Запрос на получение результата изменения настроек (лимитов) карт СУП. В ответ сервис отдает результат успешно измененных настроек и отклоненных карт.
URL
GET https://rest.lksup.ru/v1/limits/result/{setLimitsCardsId}
Описание
Метод возвращает результат запроса изменения настроек (лимитов) карт СУП.
Для выполнения запроса необходимо предоставить: - Авторизационные данные — JWT access токен - Данные о запросе - идентификатор запроса изменение лимитов.
Примечание: Убедитесь, что переданные данные корректны и шифруются в соответствии с требованиями API. Подробнее ознакомиться с информацией о шифровании можно по ссылке
Структура запроса
В HTTP Header необходимо передать x-nonce, также в заголовок Authorization, помещается JWT токен. - Данные о запросе — идентификатор запроса изменение лимитов. - X-Nonce: — значение состоит из случайных символов, используется в шифровании (передается в заголовке)
Пример запроса:
Формат запроса:
GET https://rest.lksup.ru/v1/limits/result/{setLimitsCardsId}
Тело запроса:
{
"setLimitsCardsId": "uuid"
}
Параметры запроса
| Параметр | Тип | Описание | Обязательный | Шифрование |
|---|---|---|---|---|
setLimitsCardsId |
uuid | Идентификатор запроса на изменения лимитов (настроек) карт | Да | Да |
Структура ответа
Пример успешного ответа - код 200
{
"data":[
{
"errorSetLimit": "",
"idCard": "0194639b-6029-7300-a564-b082d8992725",
"limit": {
"amount": 2000,
"days": [1, 2],
"times": [
{"from": "10:00",
"to": "15:59"}],
"period": "CQUARTET",
"unlimited": true },
"resultSetLimit": true
}]
}
Параметры успешного ответа
| Параметр | Тип | Описание |
|---|---|---|
errorSetLimit |
string | Описание ошибки |
limit |
objec | Установленные лимиты (настройки) карты |
amount |
integer | Сумма в копейках, которая доступна для трат сотруднику в установленный период |
days |
array of integers | Цифрами задаются дни недели, в которые сотрудник может рассчитываться картой. Значения: 1 - понедельник; 2 - вторник; 3 - среда; 4 - четверг 5 - пятница; 6 - суббота; 7 - воскресенье. Если ничего не передано, то сотрудник может пользоваться картой в любой день. |
times |
array of objects | Массив промежутков времени, в течение которого сотрудник может питаться |
from |
string | Время, с которого сотрудник может питаться. Формат "ЧЧ:ММ". |
to |
string | Время, до которого сотрудник может питаться. Формат "ЧЧ:ММ". |
period |
string | Период, на который устанавливается сумма. Типы периодов (периоды календарные) CDAY - день. CWEEK - неделя CMONTH - месяц. CQUARTET - квартал. |
unlimited |
boolean | true - карта безлимитна. false - у карты есть лимиты |
resultSetLimit |
boolean | true - настройки карты изменены. false - настройки карты не применены. |
Пример ответа с ошибкой
Ответы с ошибкой могут быть двух видов.
Пример ответа для кода состояния 422
{
"data":[
{"field": "string",
"message": "string"}
]
}
Пример ответа для кодов состояния 4хх, за исключением 422
{
"message": "string"
}
Возможные ошибки
| Статус | Описание |
|---|---|
| 401 | Не авторизован. Некорректный токен |
| 404 | Запрос setLimitsCardsId не найден |
| 404 | Запрос setLimitsCardsId отменен |
| 404 | Запрос setLimitsCardsId ещё не обработан |
| 422 | Передано некорректное значение |