API node: различия между версиями
Admin (обсуждение | вклад) |
Admin (обсуждение | вклад) |
||
| Строка 13: | Строка 13: | ||
== Подкатегории == | == Подкатегории == | ||
==== add ==== | ==== add ==== | ||
| Строка 49: | Строка 38: | ||
[id] => ID добавленного объекта в случае успеха | [id] => ID добавленного объекта в случае успеха | ||
) | ) | ||
==== add_mark ==== | |||
Описание: Добавление метки | |||
Обязательные параметры: | |||
node_id - ID дома | |||
mark_id - ID метки | |||
==== change_custom_icon==== | |||
Описание: Изменение собственного значка на карте | |||
Обязательные параметры: | |||
id - ID объекта | |||
custom_icon_id - ID значка | |||
==== delete_mark ==== | |||
Описание: Снятие метки | |||
Обязательные параметры: | |||
node_id - ID дома | |||
mark_id - ID метки | |||
==== edit ==== | ==== edit ==== | ||
| Строка 70: | Строка 77: | ||
array( | array( | ||
[id] => ID объекта в случае успеха | [id] => ID объекта в случае успеха | ||
) | |||
==== get ==== | |||
Описание: Список объектов | |||
Обязательные параметры: | |||
нет | |||
Необязательные параметры: | |||
id - перечень ID объектов ''(через запятую)'' | |||
Дополнительно возвращаемые данные: | |||
array( | |||
[data] => Данные об объектах | |||
) | ) | ||
| Строка 81: | Строка 99: | ||
[Id] => ID объекта в случае успеха | [Id] => ID объекта в случае успеха | ||
) | ) | ||
Версия от 15:29, 15 июня 2017
Раздел API ERP "UserSide"
Назначение: Объекты инфраструктуры (узлы связи, муфты, опоры, колодцы)
Дополнительные параметры: action - подкатегория запроса (возможное значение: см.ниже)
ID типов объектов инфраструктуры:
0 - узел связи 1 - муфта 2 - опора 3 - колодец
Подкатегории
add
Описание: Добавление объекта Обязательные параметры: нет Дополнительные параметры: type - Тип объекта city_id - ID населенного пункта размещения объекта custom_icon_id - ID индивидуального значка на карте comment - заметки date_add - дата добавления entrance - номер подъезда house_id - ID дома размещения объекта inventory_number - инв.номер объекта is_planned - Флаг - объект только запланирован location - размещение объекта (текстовое) node_parent_id - ID родительского объекта number - номер объекта owner_id - ID собственника map_id - ID карты coordinates - координаты в текстовом виде через запятую (пример: 47.839628,35.140553) Дополнительно возвращаемые данные: array( [id] => ID добавленного объекта в случае успеха )
add_mark
Описание: Добавление метки Обязательные параметры: node_id - ID дома mark_id - ID метки
change_custom_icon
Описание: Изменение собственного значка на карте Обязательные параметры: id - ID объекта custom_icon_id - ID значка
delete_mark
Описание: Снятие метки Обязательные параметры: node_id - ID дома mark_id - ID метки
edit
Описание: Редактирование объекта Обязательные параметры: id - ID объекта Необязательные параметры: city_id - ID населенного пункта размещения объекта custom_icon_id - ID индивидуального значка на карте comment - заметки date_add - дата добавления entrance - номер подъезда house_id - ID дома размещения объекта inventory_number - инв.номер объекта is_planned - Флаг - объект только запланирован location - размещение объекта (текстовое) node_parent_id - ID родительского объекта number - номер объекта owner_id - ID собственника Дополнительно возвращаемые данные: array( [id] => ID объекта в случае успеха )
get
Описание: Список объектов Обязательные параметры: нет Необязательные параметры: id - перечень ID объектов (через запятую) Дополнительно возвращаемые данные: array( [data] => Данные об объектах )
get_node_id
Описание: Получение ID объекта по входящим данным Обязательные параметры: data_typer - тип данных, которые проверяем (Возможные значения: number) data_value - значение Дополнительно возвращаемые данные: array( [Id] => ID объекта в случае успеха )