API address

Раздел API ERP "UserSide"

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

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

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

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

get

Добавлено в 3.13.9

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

Область

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

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

get_house

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

edit_house

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

del_house

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

add_house_mark

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

delete_house_mark

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

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