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

Материал из WiKi - UserSide
(Новая страница: «en | ru Section '''API''' ERP "UserSide"»)
 
Нет описания правки
Строка 2: Строка 2:


Section '''[[API_EN|API]]''' ERP "UserSide"
Section '''[[API_EN|API]]''' ERP "UserSide"
Purpose: Staff
Additional parameters:
action - request subcategory ''(possible value: see below)''
== Subcategories ==
====(*) get_data ====
''Deprecated in: 3.16dev2 (use API->employee->[[API employee#get_data|get_data]])''
''Modified in: 3.14.65 (made id parameter optional and added option to specify it with comma)''
Description: Retrieve information about an employee
Optional parameters:
  id - id of the employee to be selected ''(can be comma separated)''
==== (*) get_staff_id ====
''Deprecated in: 3.16dev2 (use API->employee->[[API employee#get_employee_id|get_employee_id]])''
Description: Get employee ID from incoming data
Obligatory parameters:
  data_typer - type of data being checked ''(possible values: additional_field_XXX, name)''
  data_value - value
==== (*) get_division ====
''Deprecated in: 3.16dev2 (use API->employee->[[API employee#get_division|get_division]])''
''Added in: 3.12.18''
Description: Get division information
Optional parameters:
  id - division ID (can be comma separated)
==== (*) get_division_list ====
''Deprecated in: 3.16dev2 (use API->employee->[[API employee#get_division_list|get_division_list]])''
''Added in: 3.12.89''
Description: List of divisions
==== (*) get_timesheet_data ====
''Deprecated in: 3.16dev2 (use API->employee->[[API employee#get_timesheet_data|get_timesheet_data]])''
''Added in: 3.15.12''
Description: Retrieve information from the timesheet
Obligatory parameters:
  date_from - start date of selection
  date_to - date of selection end
Optional parameters:
  staff_id - staff ID (can be comma separated)
  division_id - ID of division (can be comma separated)
==== (*) set_timesheet_data ====
''Deprecated in: 3.16dev2 (use API->employee->[[API employee#set_timesheet_data|set_timesheet_data]])''
''Added in: 3.15.12''
Description: Add/modify/delete a timesheet entry
Obligatory parameters:
  staff_id - employee id
  date - date
  type_id - id of record type ''(1 - basic time, 2 - overtime, 3 - other)''
  value - number of hours ''(integer value, either: 994 - on duty, 995 - off, 996 - holiday, 997 - day off, 998 - sick leave, 999 - business trip, or 0 to delete the record)''

Версия от 14:34, 1 сентября 2023

en | ru

Section API ERP "UserSide"

Purpose: Staff

Additional parameters:
action - request subcategory (possible value: see below)

Subcategories

(*) get_data

Deprecated in: 3.16dev2 (use API->employee->get_data)

Modified in: 3.14.65 (made id parameter optional and added option to specify it with comma)

Description: Retrieve information about an employee
Optional parameters:
 id - id of the employee to be selected (can be comma separated)

(*) get_staff_id

Deprecated in: 3.16dev2 (use API->employee->get_employee_id)

Description: Get employee ID from incoming data
Obligatory parameters:
 data_typer - type of data being checked (possible values: additional_field_XXX, name)
 data_value - value

(*) get_division

Deprecated in: 3.16dev2 (use API->employee->get_division)

Added in: 3.12.18

Description: Get division information
Optional parameters:
 id - division ID (can be comma separated)

(*) get_division_list

Deprecated in: 3.16dev2 (use API->employee->get_division_list)

Added in: 3.12.89

Description: List of divisions

(*) get_timesheet_data

Deprecated in: 3.16dev2 (use API->employee->get_timesheet_data)

Added in: 3.15.12

Description: Retrieve information from the timesheet
Obligatory parameters:
 date_from - start date of selection
 date_to - date of selection end
Optional parameters:
 staff_id - staff ID (can be comma separated)
 division_id - ID of division (can be comma separated)

(*) set_timesheet_data

Deprecated in: 3.16dev2 (use API->employee->set_timesheet_data)

Added in: 3.15.12

Description: Add/modify/delete a timesheet entry
Obligatory parameters:
 staff_id - employee id
 date - date
 type_id - id of record type (1 - basic time, 2 - overtime, 3 - other)
 value - number of hours (integer value, either: 994 - on duty, 995 - off, 996 - holiday, 997 - day off, 998 - sick leave, 999 - business trip, or 0 to delete the record)