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

Текущая версия от 11:19, 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 - нотатки

@@ Строка 1: / Строка 1: @@
 [[API_employee_EN|en]] | '''uk''' | [[API employee|ru]]
-Розділ '''[[API]]''' ERP "UserSide"
+Розділ '''[[API_UK|API]]''' ERP "UserSide"
 Призначення: Співробітники
@@ Строка 14: / Строка 14: @@
 ''Додано у: 3.18beta1''
-  Опис: Собудівля PUSH-увебудинокления для співробітника
+  Опис: Створення PUSH-повідомлення для співробітника
   Обов'язкові параметри:
    employee_id - ID співробітника
    body - текст
   Необов'язкові параметри:
-   color - HTML-колір окна с увебудиноклением
+   color - HTML-колір вікна з повідомленням
 ==== address_access_add ====
@@ Строка 25: / Строка 25: @@
 ''Додано у: 3.18beta1''
-  Опис: Додавання адресного об'єкта в доступні адреса для співробітника
+  Опис: Додавання адресного об'єкта до доступних адрес для співробітника
   Обов'язкові параметри:
    employee_id - id співробітника
-   address_id - id адресного об'єкта ''(-1 для всіх адрес, -2 для об'єктів без адреса)''
+   address_id - id адресного об'єкта ''(-1 для всіх адрес, -2 для об'єктів без адреси)''
-   is_write - прапорець - доступ на запись
+   is_write - прапорець - доступ на запис
 ==== address_access_list ====
@@ Строка 38: / Строка 38: @@
   Обов'язкові параметри:
    employee_id - id співробітника
-   is_write - прапорець - доступ на запись
+   is_write - прапорець - доступ на запис
 ==== address_access_remove ====
@@ Строка 44: / Строка 44: @@
 ''Додано у: 3.18beta1''
-  Опис: Видалення адресного об'єкта из доступних адрес для співробітника
+  Опис: Видалення адресного об'єкта з доступних адрес для співробітника
   Обов'язкові параметри:
    employee_id - id співробітника
-   address_id - id адресного об'єкта ''(-1 для всіх адрес, -2 для об'єктів без адреса)''
+   address_id - id адресного об'єкта ''(-1 для всіх адрес, -2 для об'єктів без адреси)''
 ==== check_pass ====
 ''Додано у: 3.16dev2''
-  Опис: Проверка совпадения логіна і пароля на вход в UserSide
+  Опис: Перевірка збігу логіна і пароля для входу в UserSide
   Обов'язкові параметри:
    login - логін
@@ Строка 60: / Строка 60: @@
 ==== division_employee_add ====
 ''Додано у: 3.19.44''
-  Опис: Назначення співробітника в подразделение
+  Опис: Призначення співробітника до підрозділу
   Обов'язкові параметри:
    division_id - ID підрозділу
@@ Строка 71: / Строка 71: @@
 ==== division_employee_remove ====
 ''Додано у: 3.19.44''
-  Опис: Виключення співробітника из підрозділу
+  Опис: Вилучення співробітника з підрозділу
   Обов'язкові параметри:
    division_id - ID підрозділу
    employee_id - ID співробітника
   Необов'язкові параметри:
-   date_remove - дата исключения
+   date_remove - дата вилучення
 ==== edit ====
@@ Строка 86: / Строка 86: @@
 ''Додано у: 3.18beta1''
-  Опис: Редагування запису о співробітнике
+  Опис: Редагування запису про співробітника
   Обов'язкові параметри:
    id - id співробітника
   Необов'язкові параметри:
-   date_birthday - дата рождения
+   date_birthday - дата народження
-   date_in - дата принятия на работу
+   date_in - дата прийняття на роботу
-   date_out - дата увольнения
+   date_out - дата звільнення
-   first_name - имя
+   first_name - ім'я
    gps_id - IMEI gps-треккера
    ip_phone - номер IP-телефона
-   is_blocked - прапорець - заблокировать/разблокировать облікову запись
+   is_blocked - прапорець - заблокувати/розблокувати обліковий запис
-   middle_name - отчество
+   middle_name - по батькові
-   last_name - фамабоя
+   last_name - прізвище
    position - посада
-   short_name - сокращенное имя/фамабоя
+   short_name - скорочене ім'я/прізвище
    messenger_chat_id - telegram/messenger chat_id
 ==== get_data ====
 ''Додано з: 3.16dev2''
-  Опис: Отримання информации о співробітнике
+  Опис: Отримання інформації про співробітника
   Необов'язкові параметри:
    id - id співробітника для вибірки ''(можна через кому)''
@@ Строка 111: / Строка 111: @@
 ==== get_division ====
 ''Додано у: 3.16dev2''
-  Опис: Отримання информации о підрозділі
+  Опис: Отримання інформації про підрозділ
   Необов'язкові параметри:
    id - ID підрозділу ''(можна через кому)''
@@ Строка 133: / Строка 133: @@
 ''Додано у: 3.16dev2''
-  Опис: История дій ''(лимит 10000 записів в результатах вибірки)''
+  Опис: Історія дій ''(ліміт 10000 записів у результатах вибірки)''
   Обов'язкові параметри:
-   date_from - дата начала вибірки ''(з)''
+   date_from - дата початку вибірки ''(з)''
-   date_to - дата окончания вибірки ''(по)''
+   date_to - дата закінчення вибірки ''(до)''
   Необов'язкові параметри:
    employee_id - id співробітника ''(можна через кому)''
-   type_id - id типа дій ''(можна через кому)''
+   type_id - id типу дій ''(можна через кому)''
-   object_id - id связанного об'єкта ''(можна через кому)''
+   object_id - id пов'язаного об'єкта ''(можна через кому)''
 ==== get_history_type ====
 ''Додано у: 3.16dev2''
-  Опис: Типи дій в истории
+  Опис: Типи дій в історії
   Необов'язкові параметри:
-   id - id типа дій
+   id - id типу дій
 ==== get_timesheet_data ====
 ''Додано у: 3.16dev2''
-  Опис: Отримання информации из табеля работ
+  Опис: Отримання інформації з табеля робіт
   Обов'язкові параметри:
-   date_from - дата начала вибірки
+   date_from - дата початку вибірки
-   date_to - дата окончания вибірки
+   date_to - дата закінчення вибірки
   Необов'язкові параметри:
    employee_id - id співробітника ''(можна через кому)''
@@ Строка 160: / Строка 160: @@
 ==== get_work_time_data ====
 ''Додано у: 3.17dev1''
-  Опис: Отримання информации о рабочем часу співробітников
+  Опис: Отримання інформації про робочий час співробітників
   Обов'язкові параметри:
-   date_from - дата начала вибірки
+   date_from - дата початку вибірки
-   date_to - дата окончания вибірки
+   date_to - дата закінчення вибірки
   Необов'язкові параметри:
    employee_id - id співробітника ''(можна через кому)''
@@ Строка 170: / Строка 170: @@
 ''Додано у: 3.18beta1''
-  Опис: Отримання информации о недоступности співробітника ''(відпустка, лікарняний)''
+  Опис: Отримання інформації про недоступність співробітника ''(відпустка, лікарняний)''
   Обов'язкові параметри:
    немає
   Необов'язкові параметри:
    employee_id - id співробітника
-   date_from - дата начала періоду
+   date_from - дата початку періоду
-   date_to - дата окончания періоду
+   date_to - дата закінчення періоду
 ==== set_timesheet_data ====
-''Доопрацьовано у: 3.17dev1 (изменена логика параметра value)''
+''Доопрацьовано у: 3.17dev1 (змінено логіку параметра value)''
 ''Додано у: 3.16dev2''
-  Опис: Додавання/зміна/видалення запису в табель работ
+  Опис: Додавання/зміна/видалення запису в табель робіт
   Обов'язкові параметри:
    employee_id - id співробітника
    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 для видалення запису)''
@@ Строка 193: / Строка 193: @@
 ''Додано у: 3.17dev1''
-  Опис: Додавання/зміна/видалення запису о недоступности співробітника ''(відпустка, лікарняний)''
+  Опис: Додавання/зміна/видалення запису про недоступність співробітника ''(відпустка, лікарняний)''
   Обов'язкові параметри:
    employee_id - ID співробітника
-   date_from - дата начала періоду
+   date_from - дата початку періоду
-   date_to - дата окончания періоду
+   date_to - дата закінчення періоду
   Необов'язкові параметри:
-   type_id - id типа запису ''(1 - відпустка, 2 - лікарняний, не заполнено - удалить запись)''
+   type_id - id типу запису ''(1 - відпустка, 2 - лікарняний, не заповнено - видалити запис)''
 ==== task_address_access_add ====
@@ Строка 205: / Строка 205: @@
 ''Додано у: 3.18beta1''
-  Опис: Додавання адресного об'єкта в список адрес, куда може бути назначен співробітник на роботи
+  Опис: Додавання адресного об'єкта до списку адрес, куди співробітника можна призначити на роботи
   Обов'язкові параметри:
    employee_id - id співробітника
-   address_id - id адресного об'єкта ''(-1 для всіх адрес, -2 для об'єктів без адреса)''
+   address_id - id адресного об'єкта ''(-1 для всіх адрес, -2 для об'єктів без адреси)''
 ==== task_address_access_list ====
@@ Строка 214: / Строка 214: @@
 ''Додано у: 3.18beta1''
-  Опис: Список адрес, куда може бути назначен співробітник на роботи
+  Опис: Список адрес, куди співробітника можна призначити на роботи
   Обов'язкові параметри:
    employee_id - id співробітника
@@ Строка 225: / Строка 225: @@
   Обов'язкові параметри:
    employee_id - id співробітника
-   address_id - id адресного об'єкта ''(-1 для всіх адрес, -2 для об'єктів без адреса)''
+   address_id - id адресного об'єкта ''(-1 для всіх адрес, -2 для об'єктів без адреси)''
 ==== work_time_finish ====
 ''Додано у: 3.16dev5''
-  Опис: Фіксація момента окончания рабочего часу співробітника
+  Опис: Фіксація моменту закінчення робочого часу співробітника
   Обов'язкові параметри:
    employee_id - id співробітника
@@ Строка 238: / Строка 238: @@
 ==== work_time_start ====
 ''Додано у: 3.16dev5''
-  Опис: Фіксація момента начала рабочего часу співробітника
+  Опис: Фіксація моменту початку робочого часу співробітника
   Обов'язкові параметри:
    employee_id - id співробітника