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

Материал из WiKi - UserSide
(Sync English API page with Russian API documentation)
(Fix Ukrainian API localization)
 
(не показаны 3 промежуточные версии этого же участника)
Строка 1: Строка 1:
[[API_setting_EN|en]] | [[API_setting|ru]]
'''en''' | [[API_setting_UK|uk]] | [[API setting|ru]]


Section '''[[API_EN|API]]''' ERP "UserSide"
Section '''[[API_EN|API]]''' ERP "UserSide"


Purpose: Setting
Purpose: Settings


  Optional parameters:
  Optional parameters:
Строка 13: Строка 13:
''Added in: 3.12.13''
''Added in: 3.12.13''
  Description: Get values of settings parameters
  Description: Get values of settings parameters
  Obligatory parameters:
  Required parameters:
   id - ID of setting parameters ''(can be comma separated)''
   id - ID of setting parameters ''(can be comma separated)''


Строка 26: Строка 26:
==== mark_add ====
==== mark_add ====
  Description: Add mark/layer for equipment/objects
  Description: Add mark/layer for equipment/objects
  Obligatory parameters:
  Required parameters:
   name - name
   name - name
  Optional parameters:
  Optional parameters:
Строка 36: Строка 36:
==== mark_edit ====
==== mark_edit ====
  Description: Edit mark
  Description: Edit mark
  Obligatory parameters:
  Required parameters:
   id - ID of the mark
   id - ID of the mark
  Optional parameters:
  Optional parameters:
Строка 44: Строка 44:
==== mark_delete ====
==== mark_delete ====
  Description: Delete mark
  Description: Delete mark
  Obligatory parameters:
  Required parameters:
   id - ID of the mark
   id - ID of the mark

Текущая версия от 11:38, 10 мая 2026

en | uk | ru

Section API ERP "UserSide"

Purpose: Settings

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

Subcategories

get

Added in: 3.12.13

Description: Get values of settings parameters
Required 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
Required parameters:
 name - name
Optional parameters:
 color - color
 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
Required parameters:
 id - ID of the mark
Optional parameters:
 name - name
 + all listed in mark_add

mark_delete

Description: Delete mark
Required parameters:
 id - ID of the mark