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

Материал из WiKi - UserSide
Нет описания правки
 
(не показано 9 промежуточных версий 1 участника)
Строка 1: Строка 1:
[[API_employee_EN|en]] | [[API_employee|ru]]
Раздел '''[[API]]''' ERP "UserSide"
Раздел '''[[API]]''' ERP "UserSide"


Строка 7: Строка 9:


== Подкатегории ==
== Подкатегории ==
==== 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 ====
==== check_pass ====
''Добавлено с: 3.16dev2''
''Добавлено в: 3.16dev2''
  Описание: Проверка совпадения логина и пароля на вход в UserSide
  Описание: Проверка совпадения логина и пароля на вход в UserSide
  Обязательные параметры:
  Обязательные параметры:
   login - логин
   login - логин
   pass - пароль
   pass - пароль
С версии 3.16.28 при успешной аутентификации обновляется дата активности у сотрудника
==== edit ====
''Добавлено в: 3.18beta1''
Описание: Редактирование записи о сотруднике
Обязательные параметры:
  id - id сотрудника
Необязательные параметры:
  date_birthday - дата рождения
  date_in - дата принятия на работу
  date_out - дата уольнения
  first_name - имя
  gps_id - IMEI gps-треккера
  middle_name - отчество
  last_name - фамилия
  position - должность
  short_name - сокращенное имя/фамилия
  messenger_chat_id - telegram/messenger chat_id


==== get_data ====
==== get_data ====
Строка 22: Строка 84:


==== get_division ====
==== get_division ====
''Добавлено с: 3.16dev2''
''Добавлено в: 3.16dev2''
  Описание: Получение информации о подразделении
  Описание: Получение информации о подразделении
  Необязательные параметры:
  Необязательные параметры:
Строка 28: Строка 90:


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


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


Строка 41: Строка 106:
''Доработано в: 3.16dev6 (добавлен параметр object_id)''
''Доработано в: 3.16dev6 (добавлен параметр object_id)''


''Добавлено с: 3.16dev2''
''Добавлено в: 3.16dev2''
  Описание: История действий ''(лимит 10000 записей в результатах выборки)''
  Описание: История действий ''(лимит 10000 записей в результатах выборки)''
  Обязательные параметры:
  Обязательные параметры:
Строка 52: Строка 117:


==== get_history_type ====
==== get_history_type ====
''Добавлено с: 3.16dev2''
''Добавлено в: 3.16dev2''
  Описание: Типы действий в истории
  Описание: Типы действий в истории
  Необязательные параметры:
  Необязательные параметры:
Строка 58: Строка 123:


==== get_timesheet_data ====
==== get_timesheet_data ====
''Добавлено с: 3.16dev2''
''Добавлено в: 3.16dev2''
  Описание: Получение информации из табеля работ
  Описание: Получение информации из табеля работ
  Обязательные параметры:
  Обязательные параметры:
Строка 68: Строка 133:


==== get_work_time_data ====
==== get_work_time_data ====
''Добавлено с: 3.17dev1''
''Добавлено в: 3.17dev1''
  Описание: Получение информации о рабочем времени сотрудников
  Описание: Получение информации о рабочем времени сотрудников
  Обязательные параметры:
  Обязательные параметры:
Строка 75: Строка 140:
  Необязательные параметры:
  Необязательные параметры:
   employee_id - id сотрудника ''(можно через запятую)''
   employee_id - id сотрудника ''(можно через запятую)''
==== get_unavailable_data ====
''Добавлено в: 3.18beta1''
Описание: Получение информации о недоступности сотрудника ''(отпуск, больничный)''
Обязательные параметры:
  нет
Необязательные параметры:
  employee_id - id сотрудника
  date_from - дата начала периода
  date_to - дата окончания периода


==== set_timesheet_data ====
==== set_timesheet_data ====
''Добавлено с: 3.16dev2''
''Доработано в: 3.17dev1 (изменена логика параметра value)''
 
''Добавлено в: 3.16dev2''
 
  Описание: Добавление/изменение/удаление записи в табель работ
  Описание: Добавление/изменение/удаление записи в табель работ
  Обязательные параметры:
  Обязательные параметры:
   employee_id - ID сотрудника
   employee_id - id сотрудника
   date - дата
   date - дата
   type_id - id типа записи ''(1 - основное время, 2 - сверхурочное, 3 - прочее)''
   type_id - id типа записи ''(1 - основное время, 2 - сверхурочное, 3 - прочее)''
   value - количество часов ''(целое значение, либо: 994 - дежурный, 995 - не вышел, 996 - отпуск, 997 - выходной, 998 - больничный, 999 - командировка, либо 0 для удаления записи)''
   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 ====
==== work_time_finish ====
''Добавлено с: 3.16dev5''
''Добавлено в: 3.16dev5''
  Описание: Фиксация момента окончания рабочего времени сотрудника  
  Описание: Фиксация момента окончания рабочего времени сотрудника  
  Обязательные параметры:
  Обязательные параметры:
Строка 95: Строка 211:


==== work_time_start ====
==== work_time_start ====
''Добавлено с: 3.16dev5''
''Добавлено в: 3.16dev5''
  Описание: Фиксация момента начала рабочего времени сотрудника  
  Описание: Фиксация момента начала рабочего времени сотрудника  
  Обязательные параметры:
  Обязательные параметры:

Текущая версия от 14:38, 11 августа 2023

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

edit

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

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