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

Текущая версия от 14:36, 29 августа 2023

Раздел API ERP "UserSide"

Назначение: Настройка

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

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

get

Добавлено с: 3.12.13

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

mark_show

Доработано в: 3.17dev1 (добавлен параметр object_type)

Описание: Вывод списка меток/слоёв для объектов
Необязательные параметры:
 object_type - тип объектов [customer]

mark_add

Описание: Добавление метки/слоя для оборудования/объектов
Обязательные параметры:
 name - наименование
Необязательные параметры:
 color - цвет
 line_type - тип линии
 is_on_map_by_default - флаг отображения на карте по-умолчанию
 type_array - массив с типами объектов для меток

mark_edit

Описание: Редактирование метки
Обязательные параметры:
 id - ID метки
Необязательные параметры:
 name - наименование
 + все перечисленные в mark_add

mark_delete

Описание: Удаление метки
Обязательные параметры:
 id - ID метки

@@ Строка 1: / Строка 1: @@
+[[API_setting_EN|en]] | [[API_setting|ru]]
 Раздел '''[[API]]''' ERP "UserSide"
@@ Строка 7: / Строка 9: @@
 == Подкатегории ==
+==== get ====
+''Добавлено с: 3.12.13''
+ Описание: Получение значений параметров настройки
+ Необязательные параметры:
+  id - ID параметров настройки ''(через запятую)''
 ==== mark_show ====
-  Описание: Вывод списка меток/слоёв для оборудования/объектов
-  Дополнительно возвращаемые данные:
+''Доработано в: 3.17dev1 (добавлен параметр object_type)''
-   array(
-   [data] => Массив с метками
+  Описание: Вывод списка меток/слоёв для объектов
-  )
+  Необязательные параметры:
+   object_type - тип объектов [customer]
 ==== mark_add ====
@@ Строка 23: / Строка 32: @@
    line_type - тип линии
    is_on_map_by_default - флаг отображения на карте по-умолчанию
-   type_array - массив с типами объектов для меток [node|coupler|pillar|manhole|fiber|coper|system_device|radio|odf|split]
+   type_array - массив с типами объектов для меток
- Дополнительно возвращаемые данные:
-  array(
-   [id] => ID метки
-  )
 ==== mark_edit ====