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

Материал из WiKi - UserSide
Нет описания правки
Строка 43: Строка 43:
   number - номер объекта
   number - номер объекта
   owner_id - ID собственника
   owner_id - ID собственника
  map_id - ID карты
  coordinates - координаты в текстовом виде через запятую ''(пример: 47.839628,35.140553)''
  Дополнительно возвращаемые данные:
  Дополнительно возвращаемые данные:
   array(
   array(

Версия от 12:10, 17 июня 2016

Раздел API ERP "UserSide"

Назначение: Объекты инфраструктуры (узлы связи, муфты, опоры, колодцы)

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

ID типов объектов инфраструктуры:

0 - узел связи
1 - муфта
2 - опора
3 - колодец

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

get

Описание: Список объектов
Обязательные параметры:
 нет
Необязательные параметры:
 id - перечень ID объектов (через запятую)
Дополнительно возвращаемые данные:
 array(
  [data] => Данные об объектах
 )

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 добавленного объекта в случае успеха
 )

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 объекта в случае успеха
 )

change_custom_icon

Описание: Изменение собственного значка на карте
Обязательные параметры:
 id - ID объекта
 custom_icon_id - ID значка

add_mark

Описание: Добавление метки
Обязательные параметры:
 node_id - ID дома
 mark_id - ID метки

delete_mark

Описание: Снятие метки
Обязательные параметры:
 node_id - ID дома
 mark_id - ID метки