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

Материал из WiKi - UserSide
Перейти к навигации Перейти к поиску
(add_house)
(owner_add)
(не показано 6 промежуточных версий этого же участника)
Строка 170: Строка 170:
  
 
==== add_house ====
 
==== add_house ====
''Изменено в 3.13.15 (добавлен параметр apart_count)''
+
''Изменено в 3.13.15 (добавлен параметр apart_count, level_count, entrance_count)''
 
  Описание: Добавление здания
 
  Описание: Добавление здания
 
  Обязательные параметры:
 
  Обязательные параметры:
Строка 181: Строка 181:
 
   area_id - id района в населенному пункте
 
   area_id - id района в населенному пункте
 
   apart_count - количество домохозяйств в здании
 
   apart_count - количество домохозяйств в здании
 +
  entrance_count - количество входов/подъездов в здании
 +
  level_count - количество этажей в здании
  
==== get_house ====
+
==== add_house_mark ====
  Описание: Список домов
+
  Описание: Добавление метки на доме
Необязательные параметры:
 
  id - перечень ID домов ''(через запятую)''
 
  city_id - ID населённых пунктов ''(можно через запятую)''
 
  area_id - ID районов населённых пунктов ''(можно через запятую)''
 
  street_id - ID улиц ''(можно через запятую)''
 
  is_disable_hidden - флаг - не отображать скрытые дома
 
Дополнительно возвращаемые данные:
 
  array(
 
  [data] => Данные об объектах
 
  )
 
 
 
==== edit_house ====
 
Описание: Редактирование дома
 
 
  Обязательные параметры:
 
  Обязательные параметры:
   id - ID дома
+
   house_id - ID дома
Необязательные параметры:
+
   mark_id - ID метки
   Перечень параметров используется аналогично методу add_house
 
  
 
==== del_house ====
 
==== del_house ====
Строка 207: Строка 195:
 
   id - ID дома
 
   id - ID дома
  
==== add_house_mark ====
+
==== delete_house_mark ====
  Описание: Добавление метки на доме
+
  Описание: Снятие метки с дома
 
  Обязательные параметры:
 
  Обязательные параметры:
 
   house_id - ID дома
 
   house_id - ID дома
 
   mark_id - ID метки
 
   mark_id - ID метки
  
==== delete_house_mark ====
+
==== edit_building_coord ====
  Описание: Снятие метки с дома
+
''Добавлено в 3.13.14''
 +
Описание: Изменение географических координат у здания/сооружения
 +
Обязательные параметры:
 +
  id - id здания
 +
  coord - координаты вершин полигона здания
 +
 
 +
==== edit_house ====
 +
  Описание: Редактирование здания
 
  Обязательные параметры:
 
  Обязательные параметры:
   house_id - ID дома
+
   id - id здания ''(для версии 3.12 и ниже)''/id адресной единицы ''(для версии 3.13 и выше)''
   mark_id - ID метки
+
  building_id - id здания ''(для версии 3.13 и выше)''
 +
Необязательные параметры:
 +
  Перечень параметров используется аналогично методу add_house
 +
 
 +
==== get_house ====
 +
Описание: Список домов
 +
Необязательные параметры:
 +
  id - перечень ID домов ''(через запятую)''
 +
  city_id - ID населённых пунктов ''(можно через запятую)''
 +
  area_id - ID районов населённых пунктов ''(можно через запятую)''
 +
   street_id - ID улиц ''(можно через запятую)''
 +
  is_disable_hidden - флаг - не отображать скрытые дома
 +
 
 +
==== owner_add ====
 +
Описание: Указание собственника для здания
 +
См. API->owner->[[API owner#bind_building|bind_building]]
 +
 
 +
==== owner_remove ====
 +
Описание: Исключение собственника у здания
 +
См. API->owner->[[API owner#unbind_building|unbind_building]]
  
==== add_house_to_map ====
+
==== (*) add_house_to_map ====
 
''Добавлено в 3.12.40''
 
''Добавлено в 3.12.40''
  
Строка 230: Строка 244:
 
   coord - координаты вершин полигона дома
 
   coord - координаты вершин полигона дома
  
==== remove_house_from_map ====
+
==== (*) remove_house_from_map ====
 
''Добавлено в 3.12.40''
 
''Добавлено в 3.12.40''
  
Строка 239: Строка 253:
 
   house_id - ID дома
 
   house_id - ID дома
 
   map_id - ID карты
 
   map_id - ID карты
 
==== edit_building_coord ====
 
''Добавлено в 3.13.14''
 
 
Описание: Изменение географических координат у здания/сооружения
 
Обязательные параметры:
 
  id - id здания
 
  coord - координаты вершин полигона здания
 

Версия 09:46, 12 июня 2019

Раздел API ERP "UserSide"

Назначение: Действие с адресами

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

Также см.: Адресная система

Адресные единицы

get

Добавлено в 3.13.9

Описание: Информация об адресных единицах
Обязательные параметры (должно быть хотя-бы одно):
 id - id объектов (можно через запятую)
 locality_type_id - тип объектов (можно через запятую)
 parent_id - id родительского объекта (можно через запятую)

get_locality_type

Добавлено в 3.13.9

Описание: Информация о типах адресных единиц
Необязательные параметры:
 token - токен типа объектов

Область

add_province

Описание: Добавление области
Обязательные параметры:
 name - Наименование
Дополнительно возвращаемые данные:
 array(
  [Id] => ID добавленной области в случае успеха
 )

edit_province

Описание: Редактирование области
Обязательные параметры:
 id - ID области
Необязательные параметры:
 Перечень параметров используется аналогично методу add_province

del_province

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

get_province

Изменено в 3.12.17 (добавлен входящий параметр id)

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

Населённый пункт

add_city

Описание: Добавление населенного пункта
Обязательные параметры:
 name - Наименование населенного пункта
Необязательные параметры:
 province_id - ID области
 district_id - ID района в области
Дополнительно возвращаемые данные:
 array(
  [Id] => ID добавленного населенного пункта в случае успеха
 )

get_city

Изменено в 3.12.17 (добавлен входящий параметр id)

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

edit_city

Описание: Редактирование населённого пункта
Обязательные параметры:
 id - ID населённого пункта
Необязательные параметры:
 Перечень параметров используется аналогично методу add_city 

del_city

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

Район в населённом пункте

add_area

Описание: Добавление района в населённом пункте
Обязательные параметры:
 city_id - ID населенного пункта
 name - Наименование
Дополнительно возвращаемые данные:
 array(
  [Id] => ID добавленного района в случае успеха
 )

get_area

Изменено в 3.12.17 (добавлен входящий параметр id)

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

edit_area

Описание: Редактирование района населённого пункта
Обязательные параметры:
 id - ID района населённого пункта
Необязательные параметры:
 Перечень параметров используется аналогично методу add_area

del_area

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

Улица

add_street

Описание: Добавление улицы
Обязательные параметры:
 city_id - ID населенного пункта
 name - Наименование
Необязательные параметры:
 area_id - ID района населенного пункта
Дополнительно возвращаемые данные:
 array(
  [Id] => ID добавленной улицы в случае успеха
 )

get_street

Изменено в 3.12.17 (добавлен входящий параметр id)

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

edit_street

Описание: Редактирование улицы
Обязательные параметры:
 id - ID улицы
Необязательные параметры:
 Перечень параметров используется аналогично методу add_street

del_street

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

Дом

add_house

Изменено в 3.13.15 (добавлен параметр apart_count, level_count, entrance_count)

Описание: Добавление здания
Обязательные параметры:
 city_id - id населенного пункта
 street_id - id улицы
 number - номер здания
 block - блок/корпус здания (для версии 3.12 и ниже)
 custom_name - Произвольное (полное) наименование здания
Необязательные параметры:
 area_id - id района в населенному пункте
 apart_count - количество домохозяйств в здании
 entrance_count - количество входов/подъездов в здании
 level_count - количество этажей в здании

add_house_mark

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

del_house

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

delete_house_mark

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

edit_building_coord

Добавлено в 3.13.14

Описание: Изменение географических координат у здания/сооружения
Обязательные параметры:
 id - id здания
 coord - координаты вершин полигона здания

edit_house

Описание: Редактирование здания
Обязательные параметры:
 id - id здания (для версии 3.12 и ниже)/id адресной единицы (для версии 3.13 и выше)
 building_id - id здания (для версии 3.13 и выше)
Необязательные параметры:
 Перечень параметров используется аналогично методу add_house

get_house

Описание: Список домов
Необязательные параметры:
 id - перечень ID домов (через запятую)
 city_id - ID населённых пунктов (можно через запятую)
 area_id - ID районов населённых пунктов (можно через запятую)
 street_id - ID улиц (можно через запятую)
 is_disable_hidden - флаг - не отображать скрытые дома

owner_add

Описание: Указание собственника для здания
См. API->owner->bind_building

owner_remove

Описание: Исключение собственника у здания
См. API->owner->unbind_building

(*) add_house_to_map

Добавлено в 3.12.40

Исключено в 3.13

Описание: Добавление дома на карту
Обязательные параметры:
 house_id - ID дома
 map_id - ID карты
 coord - координаты вершин полигона дома

(*) remove_house_from_map

Добавлено в 3.12.40

Исключено в 3.13

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