Skip to content

Добавление новых сотрудников

Метод служит для добавления новых сотрудников.

URL

POST https://rest.lksup.ru/v1/employee/add

Описание

Метод возвращает объект, созданного в сервисе СУП сотрудника.

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

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

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

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

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

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

POST https://rest.lksup.ru/v1/employee/add

Тело запроса

{
    "customId": "45678900",
    "surname": "Иванов",
    "name": "Иван",
    "patronymic": "Иванович",
    "phone": "9123456789",
    "email": "example@mail.ru",
    "idCategory": "7f21773d-1d88-4fb0-835a-a4db53befd45",
    "status": "WORK"
}

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

Параметр Тип Описание Обязательный Шифрование
customId string(64) Уникальный идентификатор сотрудника в системе партнера.
Длина 64 символа, допустимые значения строчные и заглавные а-я, a-z, 0-9, символы “-” и “_”		 Да Да
surname string(32) Фамилия сотрудника.
Длина 32 символа, допустимые значения строчные и заглавные а-я, a-z, символ “-”		 Нет Да
name string(32) Имя сотрудника.
Длина 32 символа, допустимые значения строчные и заглавные а-я, a-z, символ “-”		 Нет Да
patronymic string(32) Отчество сотрудника.
Длина 32 символа, допустимые значения строчные и заглавные а-я, a-z, символ “-”		 Нет Да
phone string(10) Номер телефона сотрудника (без указания кода страны).
Содержит цифры от 0 до 9		 Нет Да
email string Почта сотрудника.
Может содержать буквы, цифры, знаки. Имеет вид: name@damen		 Нет Да
idCategory uuid Идентификатор категории Нет Да
status uuid Cтатус сотрудника.
WORK - работает (значение по умолчанию при создании сотрудника).
VACATION - в отпуске.
MEDICAL - на больничном.
DONT_WORK - не работает, перемещен в архив.		 Нет Да
---

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

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

{
    "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": "01.01.2025"
}

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

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

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

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

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

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

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

{
  "message": "string"
}

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

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

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

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