Skip to content

Изменение статуса карты

Метод служит для изменения статуса, привязанной к сотруднику карты.

URL

POST https://rest.lksup.ru/v1/employee/{idEmployee}/card/switch

Описание

Метод позволяет изменить текущий статус карты.

Для выполнения запроса необходимо предоставить:
- Идентификатор сотрудника — идентификатор сотрудника в сервисе СУП. - Идентификатор карты — идентификатор карты. - Авторизационные данные — JWT access токен. - X-Nonce: — значение состоит из случайных символов, используется в шифровании (передается в заголовке)

Примечание: Убедитесь, что переданные данные корректны и шифруются в соответствии с требованиями API.

Структура запроса

В HTTP Header необходимо передать x-nonce, также в заголовок Authorization, помещается JWT токен. В тело запроса помещаются, предварительно зашифрованные данные о карте. idEmployee передается в path параметр.

Пример запроса

Формат запроса:

POST https://rest.lksup.ru/v1/employee/{idEmployee}/card/switch

{
  "idCard": "3f530615-e013-44b3-a4ed-7726285782a2",
  "statusCard": "ADDITIONAL"
}

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

Параметр Тип Описание Обязательный Шифрование
idEmployee uuid Уникальный идентификатор сотрудника в сервисе СУП Да Нет
idCard uuid Уникальный карты в сервисе СУП Да Нет
statusCard string Новое значение статуса карты Да Да

Возможные значения для параметра statusCard:

Наименование Описание
MAIN Основная
ADDITIONAL Дополнительная
TEMPORARILY_BLOCKED Временно заблокированная

Структура ответа

Пример успешного ответа - код 200

{
  "idEmployee": "b9157126-dcd5-424e-a4e2-ff6d932fb28a",
  "idCard": "3f530615-e013-44b3-a4ed-7726285782a2",
  "statusCard": "ADDITIONAL"
}

Параметры успешного ответа

Параметр Тип Описание
idEmployee uuid Уникальный идентификатор сотрудника в сервисе СУП
idCard uuid Уникальный карты в сервисе СУП
statusCard string Информация о статусе карты

Пример ответа с ошибкой

Ответы с ошибкой могут быть двух видов.

Пример ответа для кода состояния 422

{
  "data": [{
            "field":"string",
            "message":"string"
            },
            {
            "field":"string",
            "message":"string"
            }]
}

Пример ответа для кодов состояния 4хх, за исключением 422

{
  "message": "string"
}

Параметры ответа с ошибкой

Параметр Тип Описание
field string Наименование поля, в котором была допущена ошибка
message string Текстовое описание ошибки

Возможные ошибки

Статус Описание
401 Не авторизован. Токен не прошел валидацию
404 Сотрудник с таким idEmployee не найден. Карта с таким idCard не найдена
409 Статус карты не может быть изменен. Причина: истек срок действия карты или карта заблокирована в банке
422 Передано некорректное значение