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

Материал из WiKi - UserSide
Нет описания правки
(не показана 31 промежуточная версия этого же участника)
Строка 7: Строка 7:


ID типов объектов инфраструктуры:
ID типов объектов инфраструктуры:
  0 - узел связи
  0 - узел связи ''(до 3.14.21)''
  1 - муфта
  1 - муфта
  2 - опора
  2 - опора
  3 - колодец
  3 - колодец
4 - узел связи ''(с 3.14.21)''


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


==== add ====
==== add ====
  Описание: Добавление объекта
  Описание: Добавление объекта
  Обязательные параметры:
  Обязательные параметры:
   нет
   type - Тип объекта
  Дополнительные параметры:
  Дополнительные параметры:
  type - Тип объекта
   city_id - ID населенного пункта размещения объекта
   city_id - ID населенного пункта размещения объекта
   custom_icon_id - ID индивидуального значка на карте
   custom_icon_id - ID индивидуального значка на карте
Строка 43: Строка 32:
   number - номер объекта
   number - номер объекта
   owner_id - ID собственника
   owner_id - ID собственника
  Дополнительно возвращаемые данные:
  map_id - ID карты ''(для версии 3.12 и ранее)''
   array(
  coordinates - координаты в текстовом виде через запятую ''(пример: 47.839628,35.140553)''
  [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 ====
Строка 52: Строка 57:
  Обязательные параметры:
  Обязательные параметры:
   id - ID объекта
   id - ID объекта
  Обязательные параметры:
  Необязательные параметры:
   city_id - ID населенного пункта размещения объекта
   city_id - ID населенного пункта размещения объекта
   custom_icon_id - ID индивидуального значка на карте
   custom_icon_id - ID индивидуального значка на карте
   comment - заметки
   comment - заметки
  coordinates - координаты в текстовом виде через запятую ''(пример: 47.839628,35.140553)''
   date_add - дата добавления
   date_add - дата добавления
   entrance - номер подъезда
   entrance - номер подъезда
Строка 65: Строка 71:
   number - номер объекта
   number - номер объекта
   owner_id - ID собственника
   owner_id - ID собственника
Дополнительно возвращаемые данные:
  array(
  [id] => ID объекта в случае успеха
  )


==== change_custom_icon====
==== get ====
  Описание: Изменение собственного значка на карте
''Доработано в: 3.13.35 (добавлен параметры mark_id)''
 
''Доработано в: 3.13.14 (добавлен параметры parent_id)''
 
''Доработано в: 3.13alpha1 (добавлен параметр address_id, убраны параметры city_id, street_id, house_id)''
 
''Доработано в: 3.12.74 (добавлены параметры city_id, street_id, house_id)''
 
Описание: Список объектов
Обязательные параметры:
  нет
Необязательные параметры:
  id - id объектов ''(можно через запятую)''
  object_type - тип объекта
  address_id - id адресной единицы ''(можно через запятую)'' ''(с версии 3.13)''
  city_id - id населенного пункта ''(можно через запятую)'' ''(до версии 3.13)''
  street_id - id улицы ''(можно через запятую)'' ''(до версии 3.13)''
  house_id - id дома ''(можно через запятую)'' ''(до версии 3.13)''
  parent_id - id родительского объекта ''(можно через запятую)''
  mark_id - id метки
 
==== get_icon_list ====
Описание: Список собственных значков для объектов
Необязательные параметры:
  id - перечень ID объектов ''(через запятую)''
 
==== get_id ====
''Доработано в: 3.14.46 (добавлен параметр type_id)''
 
''Доработано в: 3.12.72 (добавлено возможное значение comment, добавлен параметр is_entry)''
 
''Доработано в: 3.12.71 (добавлено возможное значение additional_dataX)''
 
Описание: Получение ID объекта по входящим данным
Обязательные параметры:
  data_type - тип данных, которые проверяем ''(возможные значения: comment, number, additional_dataX (вместо X - id дополнительного поля))''
  data_value - значение
Необязательные параметры:
  is_entry - флаг - проверять ли в т.ч. совпадение по части вхождения в строку
  type_id - тип объекта
 
==== get_id_by_coord ====
''Добавлено в: 3.12beta30''
  Описание: Получение ID ближайшего объекта по указанным координатам
  Обязательные параметры:
  Обязательные параметры:
   id - ID объекта
   lat - широта
   custom_icon_id - ID значка
  lon - долгота
Необязательные параметры:
  type - тип объекта
   range - радиус в метрах, в пределах которого отобразить объекты


==== add_mark ====
==== get_redevelopment_scheme ====
  Описание: Добавление метки
''Добавлено в: 3.16dev3''
  Описание: Список схем перепланировки для сооружения связи
  Обязательные параметры:
  Обязательные параметры:
   node_id - ID дома
   id - id сооружения связи
  mark_id - ID метки


==== delete_mark ====
==== get_scheme ====
  Описание: Снятие метки
''Добавлено в: 3.15.15''
  Описание: Получение схемы коммутации
  Обязательные параметры:
  Обязательные параметры:
   node_id - ID дома
   id - id сооружения связи
  mark_id - ID метки
 
==== get_type_list ====
''Добавлено в: 3.16dev3''
Описание: Получение список типов сооружения связи

Версия от 19:31, 8 мая 2021

Раздел API ERP "UserSide"

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

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

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

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

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

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 карты (для версии 3.12 и ранее)
 coordinates - координаты в текстовом виде через запятую (пример: 47.839628,35.140553)

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 - заметки
 coordinates - координаты в текстовом виде через запятую (пример: 47.839628,35.140553)
 date_add - дата добавления
 entrance - номер подъезда
 house_id - ID дома размещения объекта
 inventory_number - инв.номер объекта
 is_planned - Флаг - объект только запланирован
 location - размещение объекта (текстовое)
 node_parent_id - ID родительского объекта
 number - номер объекта
 owner_id - ID собственника

get

Доработано в: 3.13.35 (добавлен параметры mark_id)

Доработано в: 3.13.14 (добавлен параметры parent_id)

Доработано в: 3.13alpha1 (добавлен параметр address_id, убраны параметры city_id, street_id, house_id)

Доработано в: 3.12.74 (добавлены параметры city_id, street_id, house_id)

Описание: Список объектов
Обязательные параметры:
 нет
Необязательные параметры:
 id - id объектов (можно через запятую)
 object_type - тип объекта
 address_id - id адресной единицы (можно через запятую) (с версии 3.13)
 city_id - id населенного пункта (можно через запятую) (до версии 3.13)
 street_id - id улицы (можно через запятую) (до версии 3.13)
 house_id - id дома (можно через запятую) (до версии 3.13)
 parent_id - id родительского объекта (можно через запятую)
 mark_id - id метки

get_icon_list

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

get_id

Доработано в: 3.14.46 (добавлен параметр type_id)

Доработано в: 3.12.72 (добавлено возможное значение comment, добавлен параметр is_entry)

Доработано в: 3.12.71 (добавлено возможное значение additional_dataX)

Описание: Получение ID объекта по входящим данным
Обязательные параметры:
 data_type - тип данных, которые проверяем (возможные значения: comment, number, additional_dataX (вместо X - id дополнительного поля))
 data_value - значение
Необязательные параметры:
 is_entry - флаг - проверять ли в т.ч. совпадение по части вхождения в строку
 type_id - тип объекта

get_id_by_coord

Добавлено в: 3.12beta30

Описание: Получение ID ближайшего объекта по указанным координатам
Обязательные параметры:
 lat - широта
 lon - долгота
Необязательные параметры:
 type - тип объекта
 range - радиус в метрах, в пределах которого отобразить объекты

get_redevelopment_scheme

Добавлено в: 3.16dev3

Описание: Список схем перепланировки для сооружения связи
Обязательные параметры:
 id - id сооружения связи

get_scheme

Добавлено в: 3.15.15

Описание: Получение схемы коммутации
Обязательные параметры:
 id - id сооружения связи

get_type_list

Добавлено в: 3.16dev3

Описание: Получение список типов сооружения связи