Документація по API від AIMap
Discover APIs, integration guides, and other documentation
Отримати об’єкти за пов'язаним документам
Востаннє оновлено 19 лютого, 2021
GET /docs/objects
Дозволяє отримати дані по об’єктам в базі AIMap по унікальному ідентифікатору дозвільних документів або по наявності у об'єктів тих чи інших пов'язаних документів (будівельний паспорт, договір підряду і тд.).
Відповідь
-
Якщо запит успішний, повертає список об'єктів з пагінацією.
Разом із списком об’єктів, кожен запит буде повертати два значення offset і has-more. Якщо has-more true потрібно відправити ще один запит, використовуючи offset, щоб отримати наступну сторінку з записами об’єктів. Зазвичай використовується з рекурсивними функціями, щоб отримати список з усіма об’єктами в базі.
|
Обов'язкові параметри
|
Як використовувати
|
Опис
|
|
API Token
|
Authorization: Bearer {token} header або token={token} параметр запиту
|
Використовується для автентифікації запиту. Токен можна згенерувати в кабінеті користувача тут.
|
| Унікальний ідентифікатор пов'язаного документу |
doc_id=
Параметр запиту,
може вказуватись декілька раз
|
Вокиростивується для пошуку об'єкту за номером дозвільного документу. За наявності doc_name може ігноруватися.
|
|
Ім'я пов'язаного документу
|
doc_name=
Параметр запиту,
може записуватись декілька раз.
|
Використувується для пошуку об'єктів, які мають вказані пов'язані документі. За наявності doc_id може ігноруватися.
|
|
Необов'язкові параметри
|
Як використовувати | Опис |
|
Ліміт
|
limit=
Параметр запиту
|
Кількість значень, які повернуться в запиті. Default 250. Максимум 1000.
|
|
Класифікатор AIMap
|
class=
Параметр запиту, може записуватись декілька раз.
|
Класифікатор, який ділиться на 16 основних груп.
|
|
Регіон
|
region=
Параметр запиту, може записуватись декілька раз.
|
Область
|
|
Етап будівництва
|
stage_building=
Параметр запиту, може записуватись декілька раз.
|
Стадія будівництва (дозволено, завершено і тд.). Defalut дозволено.
|
|
Етап документації
|
stage_documentation=
Параметр запиту, може записуватись декілька раз.
|
Етап підготовки документації
|
|
Класс наслідків
|
cons_class=
Параметр запиту, може записуватись декілька раз.
|
1 - назначні наслідки, в яких постійно перебувають 50 людай, та тимчасово - 100
2 - середнє значення, об’єкти місцевого/регіонально значення
3 - значні наслідки, об’єкти загальнодержавного значення
|
|
Поля
|
prop=
Параметр запиту, може записуватись декілька раз.
|
Перелік полів, які повернуться в запиті. Детальну структуру таблиці можна побачити в кінці документу. Default "aimap_id", "name", "description", "address", "region", "town", "date_updated",
"aimap_classifier", "consequence_class", "stage_documentation", "stage_building". |
Перелік полів для параметру prop
| Поле | Опис |
| aimap_id | Унікальний класифікатор об'єкта |
| name | Назва об'єкта |
| description | Опис об'єкта |
| kadastr | Кадастровий номер земельної ділянки |
| lon | Довгота |
| lat | Широта |
| address | Повна адреса |
| region | Область |
| town | Місто |
| street | Вулиця |
| build_num | Номер будинку |
| dk_018_2000 | Державний класифікатор будівель та споруд |
| aimap_classifier | Класифікатор об'єктів AIMap |
| consequence_class | Клас наслідків |
| stage_documentation | Етап документації |
| stage_building | Етап будівництва |
| construction_type | Тип будівництва |
| floors_number | К-сть поверхів |
| object_square | Площа об'єкта |
JSON
Example GET URL:
http://127.0.0.1:8083/docs/objects?doc_id=ЖТ142132110887
{
"objects": [
{
"address": "Україна, Житомирська область, ЖИТОМИР, вулиця Івана Гонти, 26",
"aimap_classifier": "Будинки житлові котеджного типу",
"aimap_id": "23",
"consequence_class": "невизначено",
"date_added": "2013-07-30T00:00:00Z",
"description": null,
"name": "Реконструкція з прибудовою до частини житлового будинку",
"region": "Житомирська",
"stage_building": "завершено",
"stage_documentation": "декларація про готовність об'єкта до експлуатації",
"town": "ЖИТОМИР"
}
],
"has_more": false,
"offset": 250
}