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

Материал из WiKi - UserSide
(Add Ukrainian API docs and trilingual API links)
(Fix Ukrainian API localization)
 
(не показаны 3 промежуточные версии этого же участника)
Строка 1: Строка 1:
[[API_address_EN|en]] | '''uk''' | [[API address|ru]]
[[API_address_EN|en]] | '''uk''' | [[API address|ru]]


Розділ '''[[API]]''' ERP "UserSide"
Розділ '''[[API_UK|API]]''' ERP "UserSide"


Призначення: Дія с адресами
Призначення: Робота з адресами


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


Также см.: [[Адресная система]]
Також див.: [[Адресная система_UK|Адресна система]]


=== Типы адресных единиц ===
=== Типи адресних одиниць ===


==== add_locality_type ====
==== add_locality_type ====
''Додано у 3.13.64''
''Додано у 3.13.64''
  Опис: Додавання типа адресной единицы
  Опис: Додавання типу адресної одиниці
  Обов'язкові параметри:
  Обов'язкові параметри:
   name - найменування
   name - найменування
Строка 21: Строка 21:
==== edit_locality_type ====
==== edit_locality_type ====
''Додано у 3.13.64''
''Додано у 3.13.64''
  Опис: Редагування типа адресной единицы
  Опис: Редагування типу адресної одиниці
  Обов'язкові параметри:
  Обов'язкові параметри:
   id - id
   id - id
Строка 30: Строка 30:
==== get_locality_type ====
==== get_locality_type ====
''Додано у 3.13.9''
''Додано у 3.13.9''
  Опис: Информация о типах адресных единиц
  Опис: Інформація про типи адресних одиниць
  Необов'язкові параметри:
  Необов'язкові параметри:
   token - токен
   token - токен
Строка 36: Строка 36:
==== get_alias ====
==== get_alias ====
''Додано у 3.15.7''
''Додано у 3.15.7''
  Опис: Информация об алиасах
  Опис: Інформація про аліаси


=== Адресные единицы ===
=== Адресні одиниці ===


==== add_address ====
==== add_address ====
''Додано у 3.13.64''
''Додано у 3.13.64''
  Опис: Додавання адресной единицы
  Опис: Додавання адресної одиниці
  Обов'язкові параметри:
  Обов'язкові параметри:
   locality_type_id - id типа адресной единицы
   locality_type_id - id типу адресної одиниці
   name - назва
   name - назва
  Необов'язкові параметри:
  Необов'язкові параметри:
   parent_id - id родительской адресной единицы
   parent_id - id батьківської адресної одиниці


==== get ====
==== get ====
''Змінено у 3.14.69 (добавлен входящий параметр is_disable_hidden)''
''Змінено у 3.14.69 (додано вхідний параметр is_disable_hidden)''


''Додано у 3.13.9''
''Додано у 3.13.9''


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


==== edit_address ====
==== edit_address ====
Строка 66: Строка 66:
''Додано у 3.13.60''
''Додано у 3.13.60''


  Опис: Редагування адресной единицы
  Опис: Редагування адресної одиниці
  Обов'язкові параметри:
  Обов'язкові параметри:
   id - id об'єкта
   id - id об'єкта
  Необов'язкові параметри:
  Необов'язкові параметри:
   map_color - HTML-колір полигона на карте
   map_color - HTML-колір полігона на карті
   parent_id - id родительской адресной единицы
   parent_id - id батьківської адресної одиниці


=== Область ===
=== Область ===


==== add_province ====
==== add_province ====
  Опис: Додавання области
  Опис: Додавання області
  Обов'язкові параметри:
  Обов'язкові параметри:
   name - Найменування
   name - Найменування
  Дополнительно возвращаемые данные:
  Додатково повертаються дані:
   array(
   array(
   [Id] => ID добавленной области в случае успеха
   [Id] => ID доданої області в разі успіху
   )
   )


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


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


==== get_province ====
==== get_province ====
''Змінено у 3.12.17 (добавлен входящий параметр id)''
''Змінено у 3.12.17 (додано вхідний параметр id)''
  Опис: Список областей
  Опис: Список областей
  Необов'язкові параметри:
  Необов'язкові параметри:
   id - ID областей (можна через кому)
   id - ID областей (можна через кому)
  Дополнительно возвращаемые данные:
  Додатково повертаються дані:
   array(
   array(
   [data] => Данные об об'єктах
   [data] => Дані про об'єкти
   )
   )


Строка 110: Строка 110:
==== add_district ====
==== add_district ====
''Додано у 3.13.46''
''Додано у 3.13.46''
  Опис: Додавання района
  Опис: Додавання району
  Обов'язкові параметри:
  Обов'язкові параметри:
   name - найменування
   name - найменування
Строка 116: Строка 116:
==== edit_district ====
==== edit_district ====
''Додано у 3.13.46''
''Додано у 3.13.46''
  Опис: Редагування района
  Опис: Редагування району
  Обов'язкові параметри:
  Обов'язкові параметри:
   id - id района
   id - id району
  Необов'язкові параметри:
  Необов'язкові параметри:
   Перечень параметров используется аналогично методу add_province
   Перелік параметрів використовується аналогічно до методу add_province


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


==== get_district ====
==== get_district ====
''Додано у 3.13.46''
''Додано у 3.13.46''
  Опис: Список районов
  Опис: Список районів
  Необов'язкові параметри:
  Необов'язкові параметри:
   id - id районов ''(можна через кому)''
   id - id районів ''(можна через кому)''


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


==== add_city ====
==== add_city ====
  Опис: Додавання населенного пункта
  Опис: Додавання населеного пункту
  Обов'язкові параметри:
  Обов'язкові параметри:
   name - Найменування населенного пункта
   name - Найменування населеного пункту
  Необов'язкові параметри:
  Необов'язкові параметри:
   province_id - ID области
   province_id - ID області
   district_id - ID района в области
   district_id - ID району в області
  Дополнительно возвращаемые данные:
  Додатково повертаються дані:
   array(
   array(
   [Id] => ID добавленного населенного пункта в случае успеха
   [Id] => ID доданого населеного пункту в разі успіху
   )
   )


==== get_city ====
==== get_city ====
''Змінено у 3.14.69 (добавлен входящий параметр is_disable_hidden)''
''Змінено у 3.14.69 (додано вхідний параметр is_disable_hidden)''


''Змінено у 3.13.46 (добавлен входящий параметр district_id)''
''Змінено у 3.13.46 (додано вхідний параметр district_id)''


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


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


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


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


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


==== add_area ====
==== add_area ====
  Опис: Додавання района в населённом пункте
  Опис: Додавання району в населеному пункті
  Обов'язкові параметри:
  Обов'язкові параметри:
   city_id - ID населенного пункта
   city_id - ID населеного пункту
   name - Найменування
   name - Найменування
  Дополнительно возвращаемые данные:
  Додатково повертаються дані:
   array(
   array(
   [Id] => ID добавленного района в случае успеха
   [Id] => ID доданого району в разі успіху
   )
   )


==== get_area ====
==== get_area ====
''Змінено у 3.14.69 (добавлен входящий параметр is_disable_hidden)''
''Змінено у 3.14.69 (додано вхідний параметр is_disable_hidden)''


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


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


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


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


=== Вулиця ===
=== Вулиця ===


==== add_street ====
==== add_street ====
  Опис: Додавання улицы
  Опис: Додавання вулиці
  Обов'язкові параметри:
  Обов'язкові параметри:
   city_id - ID населенного пункта
   city_id - ID населеного пункту
   name - Найменування
   name - Найменування
  Необов'язкові параметри:
  Необов'язкові параметри:
   area_id - ID района населенного пункта
   area_id - ID району населеного пункту
  Дополнительно возвращаемые данные:
  Додатково повертаються дані:
   array(
   array(
   [Id] => ID добавленной улицы в случае успеха
   [Id] => ID доданої вулиці в разі успіху
   )
   )


==== get_street ====
==== get_street ====
''Змінено у 3.14.69 (добавлен входящий параметр is_disable_hidden)''
''Змінено у 3.14.69 (додано вхідний параметр is_disable_hidden)''


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


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


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


=== Будівля ===
=== Будівля ===
Строка 255: Строка 255:
''Змінено у 3.13.15 (додано параметр apart_count, level_count, entrance_count)''
''Змінено у 3.13.15 (додано параметр apart_count, level_count, entrance_count)''


  Опис: Додавання здания
  Опис: Додавання будівлі
  Обов'язкові параметри:
  Обов'язкові параметри:
   city_id - id населеного пункту
   city_id - id населеного пункту
   street_id - id улицы
   street_id - id вулиці
   number - номер здания
   number - номер будівлі
   block - блок/корпус здания ''(для версії 3.12 і ниже)''
   block - блок/корпус будівлі ''(для версії 3.12 і нижче)''
   custom_name - Произвольное ''(полное)'' найменування здания ''(для версії 3.12 і ниже)''
   custom_name - Довільне ''(повне)'' найменування будівлі ''(для версії 3.12 і нижче)''
  Необов'язкові параметри:
  Необов'язкові параметри:
   area_id - id района в населенному пункте
   area_id - id району в населеному пункті
   apart_count - количество будинокохозяйств в здании
   apart_count - кількість квартир/приміщень у будівлі
   comment - нотатки  
   comment - нотатки  
   entrance_count - количество входов/під'їздов в здании
   entrance_count - кількість входів/під'їздів у будівлі
   level_count - количество поверхей в здании
   level_count - кількість поверхів у будівлі
   task_comment - рабочая заметка по зданию
   task_comment - робоча нотатка за будівлею
   type_id - id типа здания
   type_id - id типу будівлі


==== add_house_mark ====
==== add_house_mark ====
  Опис: Додавання метки на будиноке
  Опис: Додавання мітки на будинку
  Обов'язкові параметри:
  Обов'язкові параметри:
   house_id - ID будинока
   house_id - ID будинку
   mark_id - ID метки
   mark_id - ID мітки


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


==== delete_house_mark ====
==== delete_house_mark ====
  Опис: Снятие метки с будинока
  Опис: Зняття мітки з будинку
  Обов'язкові параметри:
  Обов'язкові параметри:
   house_id - ID будинока
   house_id - ID будинку
   mark_id - ID метки
   mark_id - ID мітки


==== edit_building_coord ====
==== edit_building_coord ====
''Додано у 3.13.14''
''Додано у 3.13.14''
  Опис: Зміна географических координат у здания/сооружения
  Опис: Зміна географічних координат у будівлі/об'єкта інфраструктури
  Обов'язкові параметри:
  Обов'язкові параметри:
   id - id будівлі
   id - id будівлі
   coord - координати вершин полигона здания
   coord - координати вершин полігона будівлі


==== get_building_structure ====
==== get_building_structure ====
''Додано у 3.16dev3''
''Додано у 3.16dev3''


  Опис: Просмотр структуры здания
  Опис: Перегляд структури будівлі
  Обов'язкові параметри:
  Обов'язкові параметри:
   id - id будівлі
   id - id будівлі
Строка 305: Строка 305:
''Додано у 3.15.20''
''Додано у 3.15.20''


  Опис: Редагування структуры здания
  Опис: Редагування структури будівлі
  Обов'язкові параметри:
  Обов'язкові параметри:
   id - id будівлі
   id - id будівлі
  Необов'язкові параметри:
  Необов'язкові параметри:
   level_list - список типов уровней ''(поверхей)'' через кому
   level_list - список типів рівнів ''(поверхів)'' через кому


==== edit_house ====
==== edit_house ====
Строка 321: Строка 321:
''Змінено у 3.13.15 (додано параметр apart_count, level_count, entrance_count)''
''Змінено у 3.13.15 (додано параметр apart_count, level_count, entrance_count)''


  Опис: Редагування здания
  Опис: Редагування будівлі
  Обов'язкові параметри:
  Обов'язкові параметри:
   id - id будівлі ''(для версії 3.12 і ниже)''/id адресної одиниці ''(для версії 3.13 і выше)''
   id - id будівлі ''(для версії 3.12 і нижче)''/id адресної одиниці ''(для версії 3.13 і вище)''
  или
  або
   building_id - id будівлі ''(для версії 3.13 і выше)''
   building_id - id будівлі ''(для версії 3.13 і вище)''
  Необов'язкові параметри:
  Необов'язкові параметри:
   area_id - id района в населенному пункте
   area_id - id району в населеному пункті
   apart_count - количество будинокохозяйств в здании
   apart_count - кількість квартир/приміщень у будівлі
   block - блок/корпус здания ''(для версії 3.12 і ниже)''
   block - блок/корпус будівлі ''(для версії 3.12 і нижче)''
   city_id - id населеного пункту
   city_id - id населеного пункту
   comment - нотатки
   comment - нотатки
   custom_name - Произвольное ''(полное)'' найменування здания ''(для версії 3.12 і ниже)''
   custom_name - Довільне ''(повне)'' найменування будівлі ''(для версії 3.12 і нижче)''
   entrance_count - количество входов/під'їздов в здании
   entrance_count - кількість входів/під'їздів у будівлі
   is_not_connected - прапорець - будівля не подключено
   is_not_connected - прапорець - будівля не підключена
   level_count - количество поверхей в здании
   level_count - кількість поверхів у будівлі
   number - номер здания
   number - номер будівлі
   street_id - id улицы
   street_id - id вулиці
   task_comment - рабочая заметка по зданию
   task_comment - робоча нотатка за будівлею
   task_interval - возможные интервалы времени для проведения работ ''(например: {"day":[[0,23],[0,23],[0,23],[0,23],[0,23],[0,23],[0,23]]})''
   task_interval - можливі інтервали часу для виконання робіт ''(наприклад: {"day":[[0,23],[0,23],[0,23],[0,23],[0,23],[0,23],[0,23]]})''
   type_id - id типа здания
   type_id - id типу будівлі


==== get_house ====
==== get_house ====
''Доопрацьовано у: 3.16dev3 (додано параметри name, limit, is_like)''
''Доопрацьовано у: 3.16dev3 (додано параметри name, limit, is_like)''


''Доопрацьовано у: 3.13.35 (додано параметры mark_id)''
''Доопрацьовано у: 3.13.35 (додано параметри mark_id)''


''Доопрацьовано у 3.13.19 (додано параметр building_id)''
''Доопрацьовано у 3.13.19 (додано параметр building_id)''


  Опис: Список будиноков
  Опис: Список будинків
  Обов'язкові параметри:
  Обов'язкові параметри:
   нет
   немає
  Необов'язкові параметри:
  Необов'язкові параметри:
   id - id будівлі ''(для версії 3.12. Можно через кому)'', id адресної одиниці ''(для версії 3.13+. Можно через кому)''
   id - id будівлі ''(для версії 3.12. Можна через кому)'', id адресної одиниці ''(для версії 3.13+. Можна через кому)''
   building_id - id будівлі ''(для версії 3.13+. Можно через кому)''
   building_id - id будівлі ''(для версії 3.13+. Можна через кому)''
   city_id - ID населённых пунктов ''(можна через кому)''
   city_id - ID населених пунктів ''(можна через кому)''
   area_id - ID районов населённых пунктов ''(можна через кому)''
   area_id - ID районів населених пунктів ''(можна через кому)''
   street_id - ID улиц ''(можна через кому)''
   street_id - ID вулиць ''(можна через кому)''
   is_disable_hidden - прапорець - не отображать скрытые будинока
   is_disable_hidden - прапорець - не відображати приховані будинки
   mark_id - id метки
   mark_id - id мітки
   name - полный адрес здания ''(согласно шаблона)''
   name - повна адреса будівлі ''(відповідно до шаблону)''
   limit - максимальное количество записей, що вернуть в ответе
   limit - максимальна кількість записів, які потрібно повернути у відповіді
   is_like - прапорець - использовать сравнение подстроки там где это возможно ''(а не полное совпадение)''
   is_like - прапорець - використовувати порівняння підрядка там, де це можливо ''(а не повний збіг)''


==== get_building_type ====
==== get_building_type ====
''Додано у 3.20.5''
''Додано у 3.20.5''


  Опис: Довідник типов зданий
  Опис: Довідник типів будівель
  Обов'язкові параметри:
  Обов'язкові параметри:
   нет
   немає


==== get_level ====
==== get_level ====
''Додано у 3.15.20''
''Додано у 3.15.20''


  Опис: Довідник типов уровней (поверхей)
  Опис: Довідник типів рівнів (поверхів)
  Обов'язкові параметри:
  Обов'язкові параметри:
   нет
   немає


==== move_child_object ====
==== move_child_object ====
''Додано у 3.16dev8''
''Додано у 3.16dev8''


  Опис: Перенос дочерних об'єктів с здания на другое будівля
  Опис: Перенесення дочірніх об'єктів з будівлі на іншу будівлю
  Обов'язкові параметри:
  Обов'язкові параметри:
   src_building_id - id исходного здания
   src_building_id - id вихідної будівлі
   dst_building_id - id будівлі-получателя
   dst_building_id - id будівлі-отримувача


==== owner_remove ====
==== owner_remove ====
  Опис: Исключение власника у здания
  Опис: Вилучення власника з будівлі
  См. API->owner->[[API owner#unbind_building|unbind_building]]
  Див. API->owner->[[API_owner_UK#unbind_building|unbind_building]]


==== (*) add_house_to_map ====
==== (*) add_house_to_map ====
Строка 395: Строка 395:
''Виключено у 3.13''
''Виключено у 3.13''


  Опис: Додавання будинока на карту
  Опис: Додавання будинку на карту
  Обов'язкові параметри:
  Обов'язкові параметри:
   house_id - ID будинока
   house_id - ID будинку
   map_id - ID карты
   map_id - ID карти
   coord - координати вершин полигона будинока
   coord - координати вершин полігона будинку


==== (*) remove_house_from_map ====
==== (*) remove_house_from_map ====
Строка 406: Строка 406:
''Виключено у 3.13''
''Виключено у 3.13''


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

Текущая версия от 11:18, 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 карти
Источник — https://wiki.userside.eu/index.php?title=API_address_UK&oldid=21479