API address
Раздел 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.16.19 (добавлен параметр type_id)
Изменено в 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 - рабочая заметка по зданию type_id - id типа здания
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.18beta1 (добавлен параметр task_interval)
Изменено в 3.16.20 (добавлен параметр type_id, is_not_connected)
Изменено в 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 - количество входов/подъездов в здании
is_not_connected - флаг - здание не подключено
level_count - количество этажей в здании
number - номер здания
street_id - id улицы
task_comment - рабочая заметка по зданию
task_interval - возможные интервалы времени для проведения работ (например: {"day":[[0,23],[0,23],[0,23],[0,23],[0,23],[0,23],[0,23]]})
type_id - id типа здания
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
Описание: Справочник типов уровней (этажей) Обязательные параметры: нет
move_child_object
Добавлено в 3.16dev8
Описание: Перенос дочерних объектов с здания на другое здание Обязательные параметры: src_building_id - id исходного здания dst_building_id - id здания-получателя
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 карты