Изменение настроек (лимитов) карт
Добавление нового запроса на изменение настроек (лимитов) карт СУП.
URL
POST https://rest.lksup.ru/v1/setlimitscards
Описание
Метод возвращает результат получения запроса на изменение настроек (лимитов) карт.
Для выполнения запроса необходимо предоставить: - Авторизационные данные — JWT access токен - Данные о картах и их настройках - идентификаторы карт и настройки лимитов.
Примечание: Перед отправкой убедитесь, что тело запроса зашифровано корректно.
Структура запроса
В HTTP Header необходимо передать x-nonce, также в заголовок Authorization, помещается JWT токен. - Данные о картах - X-Nonce: — значение состоит из случайных символов, используется в шифровании (передается в заголовке)
Пример запроса:
Формат запроса:
POST https://rest.lksup.ru/v1/setlimitscards
Тело запроса:
{
"data":[
{"idCard": "uuid"},
{"idCard": "uuid"}
],
"limit": {
"unlimited": boolean,
"amount": null,
"period": "null",
"days": [integer],
"times": [
{"from": "string",
"to": "string"},
]
}
}
Параметры запроса
| Параметр | Тип | Описание | Обязательный | Шифрование |
|---|---|---|---|---|
idCard |
uuid | Идентификатор карты в сервисе СУП | Да | Да |
limit |
object | Установленные лимиты (настройки) карты. | - | Да |
unlimited |
boolean | true - безлимитная, на карте не установлены лимиты. Можно пользоваться в любое время и любой день, сумма ограничена только балансом карты. Установить true и ввести другие настройки невозможно, возникнет конфликт. false - на карте установлены лимиты, имеет ограничения. |
Нет | Да |
amount |
string | Сумма в копейках, которая доступна для трат сотруднику в установленный период | да, если передается значение period | Да |
days |
array of integers | Цифрами задаются дни недели, в которые сотрудник может рассчитываться картой. Значения: 1 - понедельни; 2 - вторник; 3 - среда; 4 - четверг 5 - пятница; 6 - суббота; 7 - воскресенье. Если ничего не передано, то сотрудник может пользоваться картой в любой день. |
Нет | Да |
times |
array of objects | Массив промежутков времени, в течение которого сотрудник может питаться. | Нет | Да |
from |
string | Время, с которого сотрудник может питаться. Формат "ЧЧ:ММ". | Нет | Да |
to |
string | Время, до которого сотрудник может питаться. Формат "ЧЧ:ММ". | Нет | Да |
Структура ответа
Пример успешного ответа - код 202
{
"setLimitsCardsId": "019734a9-c2d1-704f-a6dd-31bb5d74b625"
}
Параметры успешного ответа
| Параметр | Тип | Описание |
|---|---|---|
setLimitsCardsId |
uuid | Идентификатор запроса на изменения лимитов (настроек) карт. |
| --- |
Пример ответа с ошибкой
Ответы с ошибкой могут быть двух видов.
Пример ответа для кода состояния 422
{
"data":[
{"field": "string",
"message": "string"}
]
}
Пример ответа для кодов состояния 4хх, за исключением 422
{
"message": "string"
}
Возможные ошибки
| Статус | Описание |
|---|---|
| 401 | Не авторизован. Некорректный токен |
| 404 | Карты [idCard,...] не найдены |
| 409 | Карты [idCard,...] присутствуют в обрабатываемом запросе {setLimitsCardsId}. Дождитесь его проведения и повторите операцию |
| 409 | У карт [idCard,...] истек срок |
| 422 | Передано некорректное значение |