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

Материал из WiKi - UserSide
Перейти к навигации Перейти к поиску
(get_province)
(get_house)
(не показаны 44 промежуточные версии этого же участника)
Строка 5: Строка 5:
 
  Дополнительные параметры:
 
  Дополнительные параметры:
 
  action - подкатегория запроса ''(возможное значение: см.ниже)''
 
  action - подкатегория запроса ''(возможное значение: см.ниже)''
 +
 +
Также см.: [[Адресная система]]
 +
 +
=== Типы адресных единиц ===
 +
 +
==== add_locality_type ====
 +
''Добавлено в 3.13.64''
 +
Описание: Добавление типа адресной единицы
 +
Обязательные параметры:
 +
  name - наименование
 +
  token - токен
 +
 +
==== edit_locality_type ====
 +
''Добавлено в 3.13.64''
 +
Описание: Редактирование типа адресной единицы
 +
Обязательные параметры:
 +
  id - id
 +
Необязательные параметры:
 +
  name - наименование
 +
  token - токен
 +
 +
==== get_locality_type ====
 +
''Добавлено в 3.13.9''
 +
Описание: Информация о типах адресных единиц
 +
Необязательные параметры:
 +
  token - токен
 +
 +
==== get_alias ====
 +
''Добавлено в 3.15.7''
 +
Описание: Информация об алиасах
 +
 +
=== Адресные единицы ===
 +
 +
==== add_address ====
 +
''Добавлено в 3.13.64''
 +
Описание: Добавление адресной единицы
 +
Обязательные параметры:
 +
  locality_type_id - id типа адресной единицы
 +
  name - название
 +
Необязательные параметры:
 +
  parent_id - id родительской адресной единицы
 +
 +
==== get ====
 +
''Изменено в 3.14.69 (добавлен входящий параметр is_disable_hidden)''
 +
 +
''Добавлено в 3.13.9''
 +
 +
Описание: Информация об адресных единицах
 +
Обязательные параметры ''(должно быть хотя-бы одно)'':
 +
  id - id объектов ''(можно через запятую)''
 +
  locality_type_id - тип объектов ''(можно через запятую)''
 +
  parent_id - id родительского объекта ''(можно через запятую)''
 +
  is_disable_hidden - флаг - не отображать скрытые адресные единицы
 +
 +
==== edit_address ====
 +
''Добавлено в 3.13.60''
 +
Описание: Редактирование адресной единицы
 +
Обязательные параметры:
 +
  id - id объекта
 +
Необязательные параметры:
 +
  map_color - HTML-цвет полигона на карте
  
 
=== Область ===
 
=== Область ===
Строка 38: Строка 99:
 
   [data] => Данные об объектах
 
   [data] => Данные об объектах
 
   )
 
   )
 +
 +
=== Район ===
 +
 +
==== add_district ====
 +
''Добавлено в 3.13.46''
 +
Описание: Добавление района
 +
Обязательные параметры:
 +
  name - наименование
 +
 +
==== edit_district ====
 +
''Добавлено в 3.13.46''
 +
Описание: Редактирование района
 +
Обязательные параметры:
 +
  id - id района
 +
Необязательные параметры:
 +
  Перечень параметров используется аналогично методу add_province
 +
 +
==== del_district ====
 +
''Добавлено в 3.13.46''
 +
Описание: Удаление района
 +
Обязательные параметры:
 +
  id - id района
 +
 +
==== get_district ====
 +
''Добавлено в 3.13.46''
 +
Описание: Список районов
 +
Необязательные параметры:
 +
  id - id районов ''(можно через запятую)''
  
 
=== Населённый пункт ===
 
=== Населённый пункт ===
Строка 54: Строка 143:
  
 
==== get_city ====
 
==== get_city ====
 +
''Изменено в 3.14.69 (добавлен входящий параметр is_disable_hidden)''
 +
 +
''Изменено в 3.13.46 (добавлен входящий параметр district_id)''
 +
 
''Изменено в 3.12.17 (добавлен входящий параметр id)''
 
''Изменено в 3.12.17 (добавлен входящий параметр id)''
 +
 
  Описание: Список населённых пунктов
 
  Описание: Список населённых пунктов
 
  Необязательные параметры:
 
  Необязательные параметры:
   id - ID населённых пунктов (можно через запятую)
+
   id - id населённого пункта ''(можно через запятую)''
   province_id - ID областей (можно через запятую)
+
   district_id - id района ''(можно через запятую)''
Дополнительно возвращаемые данные:
+
   province_id - id области ''(можно через запятую)''
   array(
+
   is_disable_hidden - флаг - не отображать скрытые населенные пункты
  [data] => Данные об объектах
 
   )
 
  
 
==== edit_city ====
 
==== edit_city ====
Строка 89: Строка 181:
  
 
==== get_area ====
 
==== get_area ====
 +
''Изменено в 3.14.69 (добавлен входящий параметр is_disable_hidden)''
 +
 
''Изменено в 3.12.17 (добавлен входящий параметр id)''
 
''Изменено в 3.12.17 (добавлен входящий параметр id)''
 +
 
  Описание: Список районов населённых пунктов
 
  Описание: Список районов населённых пунктов
 
  Необязательные параметры:
 
  Необязательные параметры:
 
   id - ID районов (можно через запятую)
 
   id - ID районов (можно через запятую)
 
   city_id - ID городов (можно через запятую)
 
   city_id - ID городов (можно через запятую)
Дополнительно возвращаемые данные:
+
   is_disable_hidden - флаг - не отображать скрытые районы
   array(
 
  [data] => Данные об объектах
 
  )
 
  
 
==== edit_area ====
 
==== edit_area ====
Строка 126: Строка 218:
  
 
==== get_street ====
 
==== get_street ====
 +
''Изменено в 3.14.69 (добавлен входящий параметр is_disable_hidden)''
 +
 
''Изменено в 3.12.17 (добавлен входящий параметр id)''
 
''Изменено в 3.12.17 (добавлен входящий параметр id)''
 
  Описание: Список улиц
 
  Описание: Список улиц
Строка 132: Строка 226:
 
   city_id - ID населённых пунктов ''(можно через запятую)''
 
   city_id - ID населённых пунктов ''(можно через запятую)''
 
   area_id - ID районов населенных пунктов ''(можно через запятую)''
 
   area_id - ID районов населенных пунктов ''(можно через запятую)''
Дополнительно возвращаемые данные:
+
   is_disable_hidden - флаг - не отображать скрытые улицы
   array(
 
  [data] => Данные об объектах
 
  )
 
  
 
==== edit_street ====
 
==== edit_street ====
Строка 149: Строка 240:
 
   id - ID улицы
 
   id - ID улицы
  
=== Дом ===
+
=== Здание ===
  
 
==== add_house ====
 
==== add_house ====
  Описание: Добавление дома
+
''Изменено в 3.13.57 (добавлен параметр comment, task_comment)''
 +
 
 +
''Изменено в 3.13.15 (добавлен параметр apart_count, level_count, entrance_count)''
 +
 
 +
  Описание: Добавление здания
 
  Обязательные параметры:
 
  Обязательные параметры:
   city_id - ID населенного пункта
+
   city_id - id населенного пункта
   street_id - ID улицы
+
   street_id - id улицы
   number - Цифровой номер дома
+
   number - номер здания
   block - Блок/корпус дома
+
   block - блок/корпус здания ''(для версии 3.12 и ниже)''
   custom_name - Произвольное (полное) наименование дома
+
   custom_name - Произвольное ''(полное)'' наименование здания ''(для версии 3.12 и ниже)''
 +
Необязательные параметры:
 +
  area_id - id района в населенному пункте
 +
  apart_count - количество домохозяйств в здании
 +
  comment - заметки
 +
  entrance_count - количество входов/подъездов в здании
 +
  level_count - количество этажей в здании
 +
  task_comment - рабочая заметка по зданию
 +
 
 +
==== 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 - координаты вершин полигона здания
 +
 
 +
==== get_building_structure ====
 +
''Добавлено в 3.16dev3''
 +
 
 +
Описание: Просмотр структуры здания
 +
Обязательные параметры:
 +
  id - id здания
 +
 
 +
==== edit_building_structure ====
 +
''Добавлено в 3.15.20''
 +
 
 +
Описание: Редактирование структуры здания
 +
Обязательные параметры:
 +
  id - id здания
 +
Необязательные параметры:
 +
  level_list - список типов уровней ''(этажей)'' через запятую
 +
 
 +
==== edit_house ====
 +
''Изменено в 3.13.57 (добавлен параметр comment, task_comment)''
 +
 
 +
''Изменено в 3.13.15 (добавлен параметр apart_count, level_count, entrance_count)''
 +
 
 +
Описание: Редактирование здания
 +
Обязательные параметры:
 +
  id - id здания ''(для версии 3.12 и ниже)''/id адресной единицы ''(для версии 3.13 и выше)''
 +
или
 +
  building_id - id здания ''(для версии 3.13 и выше)''
 
  Необязательные параметры:
 
  Необязательные параметры:
   area_id - ID района в населенному пункте
+
   area_id - id района в населенному пункте
Дополнительно возвращаемые данные:
+
  apart_count - количество домохозяйств в здании
   array(
+
  block - блок/корпус здания ''(для версии 3.12 и ниже)''
  [Id] => ID добавленного дома в случае успеха
+
   city_id - id населенного пункта
   )
+
  comment - заметки
 +
  custom_name - Произвольное ''(полное)'' наименование здания ''(для версии 3.12 и ниже)''
 +
  entrance_count - количество входов/подъездов в здании
 +
  level_count - количество этажей в здании
 +
   number - номер здания
 +
  street_id - id улицы
 +
  task_comment - рабочая заметка по зданию
  
 
==== get_house ====
 
==== get_house ====
 +
''Доработано в: 3.16dev3 (добавлены параметры name, limit, is_like)''
 +
 +
''Доработано в: 3.13.35 (добавлен параметры mark_id)''
 +
 +
''Доработано в 3.13.19 (добавлен параметр building_id)''
 +
 
  Описание: Список домов
 
  Описание: Список домов
 +
Обязательные параметры:
 +
  нет
 
  Необязательные параметры:
 
  Необязательные параметры:
   id - перечень ID домов ''(через запятую)''
+
   id - id здания ''(для версии 3.12. Можно через запятую)'', id адресной единицы ''(для версии 3.13+. Можно через запятую)''
 +
  building_id - id здания ''(для версии 3.13+. Можно через запятую)''
 
   city_id - ID населённых пунктов ''(можно через запятую)''
 
   city_id - ID населённых пунктов ''(можно через запятую)''
 
   area_id - ID районов населённых пунктов ''(можно через запятую)''
 
   area_id - ID районов населённых пунктов ''(можно через запятую)''
 
   street_id - ID улиц ''(можно через запятую)''
 
   street_id - ID улиц ''(можно через запятую)''
 
   is_disable_hidden - флаг - не отображать скрытые дома
 
   is_disable_hidden - флаг - не отображать скрытые дома
Дополнительно возвращаемые данные:
+
  mark_id - id метки
   array(
+
   name - полный адрес здания ''(согласно шаблона)''
  [data] => Данные об объектах
+
  limit - максимальное количество записей, что вернуть в ответе
   )
+
   is_like - флаг - использовать сравнение подстроки там где это возможно ''(а не полное совпадение)''
 +
 
 +
==== get_level ====
 +
''Добавлено в 3.15.20''
  
==== edit_house ====
+
  Описание: Справочник типов уровней (этажей)
  Описание: Редактирование дома
 
 
  Обязательные параметры:
 
  Обязательные параметры:
   id - ID дома
+
   нет
  Необязательные параметры:
+
 
  Перечень параметров используется аналогично методу add_house
+
==== owner_remove ====
 +
  Описание: Исключение собственника у здания
 +
См. API->owner->[[API owner#unbind_building|unbind_building]]
 +
 
 +
==== (*) add_house_to_map ====
 +
''Добавлено в 3.12.40''
  
==== del_house ====
+
''Исключено в 3.13''
Описание: Удаление дома
 
Обязательные параметры:
 
  id - ID дома
 
  
==== add_house_mark ====
+
  Описание: Добавление дома на карту
  Описание: Добавление метки на доме
 
 
  Обязательные параметры:
 
  Обязательные параметры:
 
   house_id - ID дома
 
   house_id - ID дома
   mark_id - ID метки
+
   map_id - ID карты
 +
  coord - координаты вершин полигона дома
 +
 
 +
==== (*) remove_house_from_map ====
 +
''Добавлено в 3.12.40''
 +
 
 +
''Исключено в 3.13''
  
==== delete_house_mark ====
+
  Описание: Удаление дома с карты
  Описание: Снятие метки с дома
 
 
  Обязательные параметры:
 
  Обязательные параметры:
 
   house_id - ID дома
 
   house_id - ID дома
   mark_id - ID метки
+
   map_id - ID карты

Версия 16:59, 15 апреля 2021

Раздел API ERP "UserSide"

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

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

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

Типы адресных единиц

add_locality_type

Добавлено в 3.13.64

Описание: Добавление типа адресной единицы
Обязательные параметры:
 name - наименование
 token - токен

edit_locality_type

Добавлено в 3.13.64

Описание: Редактирование типа адресной единицы
Обязательные параметры:
 id - id
Необязательные параметры:
 name - наименование
 token - токен

get_locality_type

Добавлено в 3.13.9

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

get_alias

Добавлено в 3.15.7

Описание: Информация об алиасах

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

add_address

Добавлено в 3.13.64

Описание: Добавление адресной единицы
Обязательные параметры:
 locality_type_id - id типа адресной единицы
 name - название
Необязательные параметры:
 parent_id - id родительской адресной единицы

get

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

Добавлено в 3.13.9

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

edit_address

Добавлено в 3.13.60

Описание: Редактирование адресной единицы
Обязательные параметры:
 id - id объекта
Необязательные параметры:
 map_color - HTML-цвет полигона на карте

Область

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_district

Добавлено в 3.13.46

Описание: Добавление района
Обязательные параметры:
 name - наименование

edit_district

Добавлено в 3.13.46

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

del_district

Добавлено в 3.13.46

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

get_district

Добавлено в 3.13.46

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

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

add_city

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

get_city

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

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

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

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

edit_city

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

del_city

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

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

add_area

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

get_area

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

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

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

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.14.69 (добавлен входящий параметр is_disable_hidden)

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

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

edit_street

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

del_street

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

Здание

add_house

Изменено в 3.13.57 (добавлен параметр comment, task_comment)

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

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

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 - координаты вершин полигона здания

get_building_structure

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

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

edit_building_structure

Добавлено в 3.15.20

Описание: Редактирование структуры здания
Обязательные параметры:
 id - id здания
Необязательные параметры:
 level_list - список типов уровней (этажей) через запятую

edit_house

Изменено в 3.13.57 (добавлен параметр comment, task_comment)

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

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

get_house

Доработано в: 3.16dev3 (добавлены параметры name, limit, is_like)

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

Доработано в 3.13.19 (добавлен параметр building_id)

Описание: Список домов
Обязательные параметры:
 нет
Необязательные параметры:
 id - id здания (для версии 3.12. Можно через запятую), id адресной единицы (для версии 3.13+. Можно через запятую)
 building_id - id здания (для версии 3.13+. Можно через запятую)
 city_id - ID населённых пунктов (можно через запятую)
 area_id - ID районов населённых пунктов (можно через запятую)
 street_id - ID улиц (можно через запятую)
 is_disable_hidden - флаг - не отображать скрытые дома
 mark_id - id метки
 name - полный адрес здания (согласно шаблона)
 limit - максимальное количество записей, что вернуть в ответе
 is_like - флаг - использовать сравнение подстроки там где это возможно (а не полное совпадение)

get_level

Добавлено в 3.15.20

Описание: Справочник типов уровней (этажей)
Обязательные параметры:
 нет

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 карты