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

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


Section '''[[API_EN|API]]''' ERP "UserSide"
Section '''[[API_EN|API]]''' ERP "UserSide"
Purpose: System operators
Optional parameters:
action - request subcategory ''(possible value: see below)''
== Subcategories ==
==== (*) check_pass ====
''Deprecated in: 3.16dev2 (use API->employee->[[API employee#check_pass|check_pass]])''
''Modified in: 3.13alpha1 (the pass parameter must be submitted unencrypted. Previously had to be provided in md5())''
Description: Check if login and password match for UserSide login
Obligatory parameters:
  login - login
  pass - password
==== (*) get ====
''Deprecated in: 3.16dev2 (use API->employee->[[API employee#get_data|get_data]])''
''Modified in: 3.14.69 (id parameter made optional)''
Description: Operator information
Optional parameters:
  id - operator id ''(can be comma separated)''
==== (*) get_history ====
''Deprecated in: 3.16dev2 (use API->employee->[[API employee#get_history|get_history]])''
''Modified in: 3.16.1 (added employee_id parameter, eliminated operator_id parameter)''
''Added in: 3.13.53''
Description: History of operators' actions (limit 10000 records in sampling results)
Obligatory parameters:
  date_from - sampling start date ''(from)''
  date_to - sampling end date ''(to)''
Optional parameters:
  operator_id - operator id ''(may be comma separated) (excluded from 3.16.1)''
  employee_id - employee id ''(may be comma separated) (added since 3.16.1)''
  type_id - action type id ''(may be comma separated)''
==== (*) get_history_type ====
''Deprecated in: 3.16dev2 (use API->employee->[[API employee#get_history_type|get_history_type]])''
''Added in: 3.13.53''
Description: Types of actions in operator history
Optional parameters:
  id - id of action type
==== (*) get_id_by_login ====
''Deprecated in: 3.16dev2 (use API->employee->[[API employee#get_employee_id|get_employee_id]])''
''Added in: 3.12beta29''
Description: Get operator's ID by his login name
Obligatory parameters:
  login - operator login

Версия от 15:58, 28 августа 2023

en | ru

Section API ERP "UserSide"

Purpose: System operators

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

Subcategories

(*) check_pass

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

Modified in: 3.13alpha1 (the pass parameter must be submitted unencrypted. Previously had to be provided in md5())

Description: Check if login and password match for UserSide login
Obligatory parameters:
 login - login
 pass - password

(*) get

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

Modified in: 3.14.69 (id parameter made optional)

Description: Operator information
Optional parameters:
 id - operator id (can be comma separated)

(*) get_history

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

Modified in: 3.16.1 (added employee_id parameter, eliminated operator_id parameter)

Added in: 3.13.53

Description: History of operators' actions (limit 10000 records in sampling results)
Obligatory parameters:
 date_from - sampling start date (from)
 date_to - sampling end date (to)
Optional parameters:
 operator_id - operator id (may be comma separated) (excluded from 3.16.1)
 employee_id - employee id (may be comma separated) (added since 3.16.1) 
 type_id - action type id (may be comma separated)

(*) get_history_type

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

Added in: 3.13.53

Description: Types of actions in operator history
Optional parameters:
 id - id of action type

(*) get_id_by_login

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

Added in: 3.12beta29

Description: Get operator's ID by his login name
Obligatory parameters:
 login - operator login