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

Текущая версия от 09:38, 12 ноября 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.21.92 (додано параметр gov_id)

Додано у 3.13.64

Опис: Додавання адресної одиниці
Обов'язкові параметри:
 locality_type_id - id типу адресної одиниці
 name - назва
Необов'язкові параметри:
 parent_id - id батьківської адресної одиниці
 gov_id - ID адресного об'єкта в державних базах даних

get

Доопрацьовано у: 3.21.92 (додано параметр gov_id)

Змінено у 3.14.69 (додано вхідний параметр is_disable_hidden)

Додано у 3.13.9

Опис: Інформація про адресні одиниці
Обов'язкові параметри (має бути хоча б одне):
 id - id об'єктів (можна через кому)
 locality_type_id - тип об'єктів (можна через кому)
 parent_id - id батьківського об'єкта (можна через кому)
 is_disable_hidden - прапорець - не відображати приховані адресні одиниці
 gov_id - ID адресного об'єкта в державних базах даних

edit_address

Доопрацьовано у: 3.21.92 (додано параметр gov_id)

Змінено у 3.21.0-beta.1 (додано параметр is_show_on_map)

Змінено у 3.20.4 (додано параметр parent_id)

Додано у 3.13.60

Опис: Редагування адресної одиниці
Обов'язкові параметри:
 id - id об'єкта

Необов'язкові параметри:

 map_color - HTML-колір полігона на карті
 parent_id - id батьківської адресної одиниці
 is_show_on_map - прапорець - відображати на карті
 gov_id - ID адресного об'єкта в державних базах даних

Область

add_province

Доопрацьовано у: 3.21.92 (додано параметр gov_id)

Опис: Додавання області
Обов'язкові параметри:
 name - Найменування
Необов'язкові параметри:
 gov_id - ID адресного об'єкта в державних базах даних

edit_province

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

del_province

Опис: Видалення області
Обов'язкові параметри:
 id - ID області

get_province

Доопрацьовано у: 3.21.92 (додано параметр gov_id)

Змінено у 3.12.17 (додано вхідний параметр id)

Опис: Список областей
Необов'язкові параметри:
 id - ID областей (можна через кому)
 gov_id - ID адресного об'єкта в державних базах даних

Район

add_district

Доопрацьовано у: 3.21.92 (додано параметр gov_id)

Додано у 3.13.46

Опис: Додавання району
Обов'язкові параметри:
 name - найменування
Необов'язкові параметри:
 gov_id - ID адресного об'єкта в державних базах даних

edit_district

Додано у 3.13.46

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

del_district

Додано у 3.13.46

Опис: Видалення району
Обов'язкові параметри:
 id - id району

get_district

Доопрацьовано у: 3.21.92 (додано параметр gov_id)

Додано у 3.13.46

Опис: Список районів
Необов'язкові параметри:
 id - id районів (можна через кому)
 gov_id - ID адресного об'єкта в державних базах даних

Населений пункт

add_city

Доопрацьовано у: 3.21.92 (додано параметр gov_id)

Опис: Додавання населеного пункту
Обов'язкові параметри:
 name - Найменування населеного пункту
Необов'язкові параметри:
 province_id - ID області
 district_id - ID району в області
 gov_id - ID адресного об'єкта в державних базах даних

get_city

Доопрацьовано у: 3.21.92 (додано параметр gov_id)

Змінено у 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 - прапорець - не відображати приховані населені пункти
 gov_id - ID адресного об'єкта в державних базах даних

edit_city

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

del_city

Опис: Видалення населеного пункту
Обов'язкові параметри:
 id - ID населеного пункту

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

add_area

Доопрацьовано у: 3.21.92 (додано параметр gov_id)

Опис: Додавання району в населеному пункті
Обов'язкові параметри:
 city_id - ID населеного пункту
 name - Найменування
Необов'язкові параметри:
 gov_id - ID адресного об'єкта в державних базах даних

get_area

Доопрацьовано у: 3.21.92 (додано параметр gov_id)

Змінено у 3.14.69 (додано вхідний параметр is_disable_hidden)

Змінено у 3.12.17 (додано вхідний параметр id)

Опис: Список районів населених пунктів
Необов'язкові параметри:
 id - ID районів (можна через кому)
 city_id - ID міст (можна через кому)
 is_disable_hidden - прапорець - не відображати приховані райони
 gov_id - ID адресного об'єкта в державних базах даних

edit_area

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

del_area

Опис: Видалення району населеного пункту
Обов'язкові параметри:
 id - ID району населеного пункту

Вулиця

add_street

Доопрацьовано у: 3.21.92 (додано параметр gov_id)

Опис: Додавання вулиці
Обов'язкові параметри:
 city_id - ID населеного пункту
 name - Найменування
Необов'язкові параметри:
 area_id - ID району населеного пункту
 gov_id - ID адресного об'єкта в державних базах даних

get_street

Доопрацьовано у: 3.21.92 (додано параметр gov_id)

Змінено у 3.14.69 (додано вхідний параметр is_disable_hidden)

Змінено у 3.12.17 (додано вхідний параметр id)

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

edit_street

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

del_street

Опис: Видалення вулиці
Обов'язкові параметри:
 id - ID вулиці

Будівля

add_house

Доопрацьовано у: 3.21.92 (додано параметр gov_id)

Змінено у 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 типу будівлі
 gov_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.21.92 (додано параметр gov_id)

Змінено у 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 типу будівлі
 gov_id - ID адресного об'єкта в державних базах даних

get_house

Доопрацьовано у: 3.21.92 (додано параметр gov_id)

Доопрацьовано у: 3.21.3 (додано параметри apart, entrance, floor, is_not_use)

Доопрацьовано у: 3.21.2 (додано параметр additional_data_XXX)

Доопрацьовано у: 3.21.0 (додано параметр building_type_id)

Доопрацьовано у: 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 - прапорець - використовувати порівняння підрядка там, де це можливо (а не повний збіг)
 gov_id - ID адресного об'єкта в державних базах даних

 additional_data_XXX_<filter> - значення додаткового поля та фільтр (наприклад: additional_data_999_eq=значення, additional_data_999_ne=значення, additional_data_999_like=значення, additional_data_999_notlike=значення, additional_data_999_set=1, additional_data_999_set=0)
 apart - кількість домогосподарств
 building_type_id - ID типу будівлі (можна через кому)
 entrance - кількість під'їздів
 floor - кількість поверхів
 is_not_use - прапорець — будівля не підключена

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