Skip to content

Привязка карты к сотруднику

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

URL

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

Описание

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

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

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

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

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

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

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

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

Тело запроса

{
  "customIdCard": "1234567890123",
  "statusCard": "MAIN"
}

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

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

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

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

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

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

{
  "idEmployee": "7f21773d-1d88-4fb0-835a-a4db53befd45",
  "idCard": "27207024-38fd-47d0-a5e6-695f71628cdc",
  "statusCard": "MAIN"
}

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

Параметр Тип Описание
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 не найден
404 Карта с таким customIdCard не найдена
409 У сотрудника есть основная карта. Измените её статус или добавьте как дополнительную карту
409 Карта уже привязана к другому сотруднику
409 Карта не доступна
409 У карты истёк срок годности
422 Переданные значения не прошли валидацию