Skip to content

Получение информации о сотруднике

Метод служит для получения информации о сотруднике.

URL

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

Описание

Метод возвращает информацию о сотруднике в сервисе СУП.

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

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

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

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

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

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

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

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

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

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

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

{
  "data": {
            "idEmployee": "7f21773d-1d88-4fb0-835a-a4db53befd45",
            "customId": "45678900",
            "surname": "Иванов",
            "name": "Иван",
            "patronymic": "Иванович",
            "phone": 9123456789,
            "email": "example@mail.ru",
            "idCategory": "7f21773d-1d88-4fb0-835a-a4db53befd45",
            "status": "WORK",
            "createdAt": "01.01.2025",
            "statusUpdatedAt": "05.01.2025",
            "cards": [
                      {
                        "idCard": "2d72e05d-9274-4c9f-832c-72f9d611f51d",
                        "statusCard": "MAIN"
                      },
                      {
                        "idCard": "3df3511a-f025-4f6e-813a-d5c9d18487a8",
                        "statusCard": "TEMPORARILY_BLOCKED"
                      }
            ]
  }
}

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

Параметр Тип Описание
idEmployee uuid Идентификатор сотрудника в сервисе СУП
customId string Идентификатор сотрудника в системе партнера
surname string Фамилия сотрудника
name string Имя сотрудника
patronymic string Отчество сотрудника
phone int Номер телефона сотрудника
email string Электронная почта сотрудника
idCategory uuid Идентификатор категории
status string Статус сотрудника
createdAt string Дата добавления сотрудника в сервис СУП
statusUpdateAt string Дата обновления статуса сотрудника
cards list Список карт, привязанных к сотруднику
idCard uuid Идентификатор карты в сервисе СУП
statusCard string Статус карты

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

Наименование Описание
WORK Работает (значение по умолчанию при создании сотрудника)
VACATION В отпуске
MEDICAL На больничном
DONT_WORK Не работает, перемещен в архив

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

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

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

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

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

{

data[

{"field": "string",

"message": "string"}

]

}

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

{
  "message": "string"
}

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

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

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

Статус Описание
401 Не авторизован. Токен не прошел валидацию
404 Сотрудник с таким idEmployee не найден
422 Передано некорректное значение