API employee UK

Материал из WiKi - UserSide
Версия от 11:19, 10 мая 2026; IronBot (обсуждение | вклад) (Fix Ukrainian API localization)
(разн.) ← Предыдущая версия | Текущая версия (разн.) | Следующая версия → (разн.)

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 - нотатки