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

Версия от 10:28, 10 мая 2026

en | uk | ru

Розділ 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 карти