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

Материал из WiKi - UserSide
Строка 7: Строка 7:


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


==== check_pass ====
==== check_pass ====
''Добавлено с: 3.16dev2''
''Добавлено в: 3.16dev2''
  Описание: Проверка совпадения логина и пароля на вход в UserSide
  Описание: Проверка совпадения логина и пароля на вход в UserSide
  Обязательные параметры:
  Обязательные параметры:
Строка 24: Строка 35:


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


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


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


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


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


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


==== get_work_time_data ====
==== get_work_time_data ====
''Добавлено с: 3.17dev1''
''Добавлено в: 3.17dev1''
  Описание: Получение информации о рабочем времени сотрудников
  Описание: Получение информации о рабочем времени сотрудников
  Обязательные параметры:
  Обязательные параметры:
Строка 81: Строка 92:
''Доработано в: 3.17dev1 (изменена логика параметра value)''
''Доработано в: 3.17dev1 (изменена логика параметра value)''


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


  Описание: Добавление/изменение/удаление записи в табель работ
  Описание: Добавление/изменение/удаление записи в табель работ
Строка 91: Строка 102:


==== set_unavailable_data ====
==== set_unavailable_data ====
''Добавлено с: 3.17dev1''
''Добавлено в: 3.17dev1''


  Описание: Добавление/изменение/удаление записи о недоступности сотрудника ''(отпуск, больничный)''
  Описание: Добавление/изменение/удаление записи о недоступности сотрудника ''(отпуск, больничный)''
Строка 102: Строка 113:


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


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

Версия от 11:06, 13 марта 2023

Раздел API ERP "UserSide"

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

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

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

add_notification

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

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

check_pass

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

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

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

get_data

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

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

get_division

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

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

get_division_list

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

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

get_employee_id

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

Описание: Получение ID сотрудника по входящим данным
Обязательные параметры:
 data_typer - тип данных, которые проверяем (возможные значения: additional_field_XXX, name, login)
 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 сотрудника (можно через запятую)

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 - больничный, не заполнено - удалить запись)

work_time_finish

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

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

work_time_start

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

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