Skip to content

Получение списка сотрудников

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

URL

GET https://rest.lksup.ru/v1/employees

Описание

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

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

Примечание: Перед отправкой убедитесь, что тело запроса зашифровано корректно.

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

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

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

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

GET https://rest.lksup.ru/v1/employees

Тело запроса

{
  "page": integer,
  "per_page": integer
}

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

Параметр Тип Описание Обязательный Шифрование
page integer Номер получаемой страницы (значение по умолчанию = 1) Нет Нет
per_page integer Количество записей на странице (значение по умолчанию = 15) Нет Нет

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

Пример успешного ответа - код 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",
        "statusUpdateAt": "05.01.2025"
    },
    {
       "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"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "to": 1,
    "total": 2,
    "last_page": 0,
    "per_page": 15,
    "path": "string"
  }
}

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

Параметр Тип Описание
data dict Словарь, содержащий данные по сотрудникам
idEmployee uuid Идентификатор сотрудника в сервисе СУП
customId string Идентификатор сотрудника в системе партнера
surname string Фамилия сотрудника
name string Имя сотрудника
patronymic string Отчество сотрудника
phone int Номер телефона сотрудника
email string Электронная почта сотрудника
idCategory uuid Идентификатор категории
status string Статус сотрудника
createdAt string Дата добавления сотрудника в сервис СУП
statusUpdateAt string Дата обновления статуса сотрудника
meta dict Словарь, содержащий метаданные страницы
current_page integer Номер текущей страницы
from integer Номер записи, с которой начинается список
to integer Номер записи, на которой заканчивается список
per_page integer Количество записей на странице
last_page integer Номер последней страница
path string Путь

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

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

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

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

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

{
  "message": "string"
}

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

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

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

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