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

Материал из WiKi - UserSide
(Add Ukrainian API docs and trilingual API links)
 
(Add Ukrainian API docs and trilingual API links)
Строка 51: Строка 51:
==== check_pass ====
==== check_pass ====
''Додано у: 3.16dev2''
''Додано у: 3.16dev2''
  Опис: Проверка совпадения логіна и пароля на вход в UserSide
  Опис: Проверка совпадения логіна і пароля на вход в UserSide
  Обов'язкові параметри:
  Обов'язкові параметри:
   login - логін
   login - логін
   pass - пароль
   pass - пароль


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


==== division_employee_add ====
==== division_employee_add ====
Строка 62: Строка 62:
  Опис: Назначення співробітника в подразделение
  Опис: Назначення співробітника в подразделение
  Обов'язкові параметри:
  Обов'язкові параметри:
   division_id - ID подразделения
   division_id - ID підрозділу
   employee_id - ID співробітника
   employee_id - ID співробітника
  Необов'язкові параметри:
  Необов'язкові параметри:
Строка 71: Строка 71:
==== division_employee_remove ====
==== division_employee_remove ====
''Додано у: 3.19.44''
''Додано у: 3.19.44''
  Опис: Исключение співробітника из подразделения
  Опис: Исключение співробітника из підрозділу
  Обов'язкові параметри:
  Обов'язкові параметри:
   division_id - ID подразделения
   division_id - ID підрозділу
   employee_id - ID співробітника
   employee_id - ID співробітника
  Необов'язкові параметри:
  Необов'язкові параметри:
Строка 113: Строка 113:
  Опис: Отримання информации о подразделении
  Опис: Отримання информации о подразделении
  Необов'язкові параметри:
  Необов'язкові параметри:
   id - ID подразделения ''(можна через кому)''
   id - ID підрозділу ''(можна через кому)''


==== get_division_list ====
==== get_division_list ====
''Додано у: 3.16dev2''
''Додано у: 3.16dev2''
  Опис: Список подразделений
  Опис: Список підрозділів


==== get_employee_id ====
==== get_employee_id ====
Строка 156: Строка 156:
  Необов'язкові параметри:
  Необов'язкові параметри:
   employee_id - id співробітника ''(можна через кому)''
   employee_id - id співробітника ''(можна через кому)''
   division_id - id подразделения ''(можна через кому)''
   division_id - id підрозділу ''(можна через кому)''


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


==== set_unavailable_data ====
==== set_unavailable_data ====
Строка 232: Строка 232:
  Обов'язкові параметри:
  Обов'язкові параметри:
   employee_id - id співробітника
   employee_id - id співробітника
   date - дата и час
   date - дата і час
  Необов'язкові параметри:
  Необов'язкові параметри:
   comment - нотатки
   comment - нотатки
Строка 241: Строка 241:
  Обов'язкові параметри:
  Обов'язкові параметри:
   employee_id - id співробітника
   employee_id - id співробітника
   date - дата и час
   date - дата і час
  Необов'язкові параметри:
  Необов'язкові параметри:
   comment - нотатки
   comment - нотатки

Версия от 08:36, 10 мая 2026

en | uk | ru

Розділ 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 при успешной аутентификации обновляется дата активности у співробітника

division_employee_add

Додано у: 3.19.44

Опис: Назначення співробітника в подразделение
Обов'язкові параметри:
 division_id - ID підрозділу
 employee_id - ID співробітника
Необов'язкові параметри:
 position_type - тип должности [head|deputy|worker]
 position_name - должность в подразделении
 date_add - дата назначення

division_employee_remove

Додано у: 3.19.44

Опис: Исключение співробітника из підрозділу
Обов'язкові параметри:
 division_id - ID підрозділу
 employee_id - ID співробітника
Необов'язкові параметри:
 date_remove - дата исключения

edit

Доопрацьовано у: 3.19.40 (додано параметр ip_phone)

Доопрацьовано у: 3.19.33 (додано параметр is_blocked)

Додано у: 3.18beta1

Опис: Редагування записи о співробітнике
Обов'язкові параметри:
 id - id співробітника
Необов'язкові параметри:
 date_birthday - дата рождения
 date_in - дата принятия на работу
 date_out - дата увольнения
 first_name - имя
 gps_id - IMEI gps-треккера
 ip_phone - номер IP-телефона
 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 - нотатки