API setting EN: различия между версиями
Нет описания правки |
|||
Строка 2: | Строка 2: | ||
Section '''[[API_EN|API]]''' ERP "UserSide" | Section '''[[API_EN|API]]''' ERP "UserSide" | ||
Purpose: Setting | |||
Optional parameters: | |||
action - request subcategory ''(possible value: see below)'' | |||
== Subcategories == | |||
==== get ==== | |||
''Added in: 3.12.13'' | |||
Description: Get values of settings parameters | |||
Optional parameters: | |||
id - ID of setting parameters ''(can be comma separated)'' | |||
==== mark_show ==== | |||
''Modified in: 3.17dev1 (added object_type parameter)'' | |||
Description: Output a list of marks/layers for objects | |||
Optional parameters: | |||
object_type - type of objects [customer] | |||
==== mark_add ==== | |||
Description: Add mark/layer for equipment/objects | |||
Obligatory parameters: | |||
name - name | |||
Optional parameters: | |||
colour - colour | |||
line_type - line type | |||
is_on_map_by_default - default flag of displaying on the map | |||
type_array - array with object types for labels | |||
==== mark_edit ==== | |||
Description: Edit mark | |||
Obligatory parameters: | |||
id - ID of the mark | |||
Optional parameters: | |||
name - name | |||
+ all listed in mark_add | |||
==== mark_delete ==== | |||
Description: Delete mark | |||
Obligatory parameters: | |||
id - ID of the mark |
Версия от 14:39, 29 августа 2023
Section API ERP "UserSide"
Purpose: Setting
Optional parameters: action - request subcategory (possible value: see below)
Subcategories
get
Added in: 3.12.13
Description: Get values of settings parameters Optional parameters: id - ID of setting parameters (can be comma separated)
mark_show
Modified in: 3.17dev1 (added object_type parameter)
Description: Output a list of marks/layers for objects Optional parameters: object_type - type of objects [customer]
mark_add
Description: Add mark/layer for equipment/objects Obligatory parameters: name - name Optional parameters: colour - colour line_type - line type is_on_map_by_default - default flag of displaying on the map type_array - array with object types for labels
mark_edit
Description: Edit mark Obligatory parameters: id - ID of the mark Optional parameters: name - name + all listed in mark_add
mark_delete
Description: Delete mark Obligatory parameters: id - ID of the mark