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

Материал из WiKi - UserSide
(Новая страница: «Раздел '''API''' ERP "UserSide" Назначение: Объекты инфраструктуры ''(узлы связи, муфты, опоры, ко…»)
 
(не показано 28 промежуточных версий этого же участника)
Строка 5: Строка 5:
  Дополнительные параметры:
  Дополнительные параметры:
  action - подкатегория запроса ''(возможное значение: см.ниже)''
  action - подкатегория запроса ''(возможное значение: см.ниже)''
ID типов объектов инфраструктуры:
0 - узел связи
1 - муфта
2 - опора
3 - колодец


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


==== add ====
==== add ====
  Описание: Добавление тарифа
  Описание: Добавление объекта
  Обязательные параметры:
  Обязательные параметры:
   name - Наименование тарифа
   нет
   billing_id - ID биллинга
Дополнительные параметры:
   billing_tariff_id - ID тарифа в стороннем биллинге
  type - Тип объекта
Дополнительно возвращаемые данные:
  city_id - ID населенного пункта размещения объекта
   array(
   custom_icon_id - ID индивидуального значка на карте
  [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====
==== change_custom_icon====
Строка 24: Строка 46:
   id - ID объекта
   id - ID объекта
   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 ====
''Доработано в: 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 объектов ''(через запятую)''
Дополнительно возвращаемые данные:
  array(
  [data] => Данные об объектах
  )
==== get_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 - флаг - проверять ли в т.ч. совпадение по части вхождения в строку
Дополнительно возвращаемые данные:
  array(
  [Id] => ID объекта в случае успеха
  )
==== get_id_by_coord ====
''Добавлено в: 3.12beta30''
Описание: Получение ID ближайшего объекта по указанным координатам
Обязательные параметры:
  lat - широта
  lon - долгота
Необязательные параметры:
  type - тип объекта
  range - радиус в метрах, в пределах которого отобразить объекты

Версия от 16:01, 2 октября 2019

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

get_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 - флаг - проверять ли в т.ч. совпадение по части вхождения в строку
Дополнительно возвращаемые данные:
 array(
  [Id] => ID объекта в случае успеха
 )

get_id_by_coord

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

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