API employee: различия между версиями

Текущая версия от 15:29, 20 ноября 2024

Раздел API ERP "UserSide"

Назначение: Сотрудники

Дополнительные параметры:
action - подкатегория запроса (возможное значение: см.ниже)

Подкатегории

add_notification

Добавлено в: 3.18beta1

Описание: Создание PUSH-уведомления для сотрудника
Обязательные параметры:
 employee_id - ID сотрудника
 body - текст
Необязательные параметры:
 color - HTML-цвет окна с уведомлением

address_access_add

Добавлено в: 3.18beta1

Описание: Добавление адресного объекта в доступные адреса для сотрудника
Обязательные параметры:
 employee_id - id сотрудника
 address_id - id адресного объекта (-1 для всех адресов, -2 для объектов без адреса)
 is_write - флаг - доступ на запись

address_access_list

Добавлено в: 3.18beta1

Описание: Список доступных адресных объектов для сотрудника
Обязательные параметры:
 employee_id - id сотрудника
 is_write - флаг - доступ на запись

address_access_remove

Добавлено в: 3.18beta1

Описание: Удаление адресного объекта из доступных адресов для сотрудника
Обязательные параметры:
 employee_id - id сотрудника
 address_id - id адресного объекта (-1 для всех адресов, -2 для объектов без адреса)

check_pass

Добавлено в: 3.16dev2

Описание: Проверка совпадения логина и пароля на вход в UserSide
Обязательные параметры:
 login - логин
 pass - пароль

С версии 3.16.28 при успешной аутентификации обновляется дата активности у сотрудника

edit

Доработано в: 3.19.33 (добавлен параметр is_blocked)

Добавлено в: 3.18beta1

Описание: Редактирование записи о сотруднике
Обязательные параметры:
 id - id сотрудника
Необязательные параметры:
 date_birthday - дата рождения
 date_in - дата принятия на работу
 date_out - дата увольнения
 first_name - имя
 gps_id - IMEI gps-треккера
 is_blocked - флаг - заблокировать/разблокировать учётную запись
 middle_name - отчество
 last_name - фамилия
 position - должность
 short_name - сокращенное имя/фамилия
 messenger_chat_id - telegram/messenger chat_id

get_data

Добавлено с: 3.16dev2

Описание: Получение информации о сотруднике
Необязательные параметры:
 id - id сотрудника для выборки (можно через запятую)

get_division

Добавлено в: 3.16dev2

Описание: Получение информации о подразделении
Необязательные параметры:
 id - ID подразделения (можно через запятую)

get_division_list

Добавлено в: 3.16dev2

Описание: Список подразделений

get_employee_id

Доработано в: 3.18.7 (в параметр data_typer добавлено возможное значение messenger_chat_id)

Добавлено с: 3.16dev2

Описание: Получение ID сотрудника по входящим данным
Обязательные параметры:
 data_typer - тип данных, которые проверяем (возможные значения: additional_field_XXX, name, login, messenger_chat_id)
 data_value - значение

get_history

Доработано в: 3.16dev6 (добавлен параметр object_id)

Добавлено в: 3.16dev2

Описание: История действий (лимит 10000 записей в результатах выборки)
Обязательные параметры:
 date_from - дата начала выборки (с)
 date_to - дата окончания выборки (по)
Необязательные параметры:
 employee_id - id сотрудника (можно через запятую) 
 type_id - id типа действий (можно через запятую)
 object_id - id связанного объекта (можно через запятую)

get_history_type

Добавлено в: 3.16dev2

Описание: Типы действий в истории
Необязательные параметры:
 id - id типа действий

get_timesheet_data

Добавлено в: 3.16dev2

Описание: Получение информации из табеля работ
Обязательные параметры:
 date_from - дата начала выборки
 date_to - дата окончания выборки
Необязательные параметры:
 employee_id - id сотрудника (можно через запятую)
 division_id - id подразделения (можно через запятую)

get_work_time_data

Добавлено в: 3.17dev1

Описание: Получение информации о рабочем времени сотрудников
Обязательные параметры:
 date_from - дата начала выборки
 date_to - дата окончания выборки
Необязательные параметры:
 employee_id - id сотрудника (можно через запятую)

get_unavailable_data

Добавлено в: 3.18beta1

Описание: Получение информации о недоступности сотрудника (отпуск, больничный)
Обязательные параметры:
 нет
Необязательные параметры:
 employee_id - id сотрудника
 date_from - дата начала периода
 date_to - дата окончания периода

set_timesheet_data

Доработано в: 3.17dev1 (изменена логика параметра value)

Добавлено в: 3.16dev2

Описание: Добавление/изменение/удаление записи в табель работ
Обязательные параметры:
 employee_id - id сотрудника
 date - дата
 type_id - id типа записи (1 - основное время, 2 - сверхурочное, 3 - прочее)
 value - количество часов (после 3.17dev1: количество часов или текстовая буква для отметки нерабочего периода, либо пустое значение для удаления записи; до 3.17dev1: целое значение, либо: 994 - дежурный, 995 - не вышел, 996 - отпуск, 997 - выходной, 998 - больничный, 999 - командировка, либо 0 для удаления записи)

set_unavailable_data

Добавлено в: 3.17dev1

Описание: Добавление/изменение/удаление записи о недоступности сотрудника (отпуск, больничный)
Обязательные параметры:
 employee_id - ID сотрудника
 date_from - дата начала периода
 date_to - дата окончания периода
Необязательные параметры:
 type_id - id типа записи (1 - отпуск, 2 - больничный, не заполнено - удалить запись)

task_address_access_add

Добавлено в: 3.18beta1

Описание: Добавление адресного объекта в список адресов, куда может быть назначен сотрудник на работы
Обязательные параметры:
 employee_id - id сотрудника
 address_id - id адресного объекта (-1 для всех адресов, -2 для объектов без адреса)

task_address_access_list

Добавлено в: 3.18beta1

Описание: Список адресов, куда может быть назначен сотрудник на работы
Обязательные параметры:
 employee_id - id сотрудника

task_address_access_remove

Добавлено в: 3.18beta1

Описание: Удаление адресного объекта из списка адресов, куда может быть назначен сотрудник на работы
Обязательные параметры:
 employee_id - id сотрудника
 address_id - id адресного объекта (-1 для всех адресов, -2 для объектов без адреса)

work_time_finish

Добавлено в: 3.16dev5

Описание: Фиксация момента окончания рабочего времени сотрудника 
Обязательные параметры:
 employee_id - id сотрудника
 date - дата и время
Необязательные параметры:
 comment - заметки

work_time_start

Добавлено в: 3.16dev5

Описание: Фиксация момента начала рабочего времени сотрудника 
Обязательные параметры:
 employee_id - id сотрудника
 date - дата и время
Необязательные параметры:
 comment - заметки