API address UK
Розділ 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.20.4 (додано параметр parent_id)
Додано у 3.13.60
Опис: Редагування адресной единицы Обов'язкові параметри: id - id об'єкта Необов'язкові параметри: map_color - HTML-колір полигона на карте parent_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_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_building_type
Додано у 3.20.5
Опис: Довідник типов зданий Обов'язкові параметри: нет
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 карты