Skip to content
Log in
Sign up

Документація по API від AIMap

Discover APIs, integration guides, and other documentation

Отримати об'єкт по ID

Востаннє оновлено 10 лютого, 2021

GET /objects/:objectId

Дозволяє отримати дані про об'єкт за його id.

Відповідь

  • Якщо запит успішний, повертає JSON з інформацією про об'єкт.
  • Повертає 404, якщо об'єкту не має в базі.

Обов'язкові параметри
Як використовувати
Опис
API Token
Authorization: Bearer {token} header або token={token} параметр запиту
Використовується для автентифікації запиту. Токен можна згенерувати в кабінеті користувача тут. 
Object ID
Використовується в запиті
Унікальний ідентифікатор об'єкта.

 

Необов'язкові параметри
 Як використовувати Опис
Поля
prop=
Параметр запиту, може записуватись декілька раз.
Перелік полів, які повернуться в запиті. Детальну структуру таблиці можна побачити в кінці документу. Default "aimap_id", "name", "description", "address", "region", "town", "date_updated",
"aimap_classifier", "consequence_class", "stage_documentation", "stage_building".
* Перелік можливих варіантів записів в полях, можна отримати за окремим запитом
JSON
Example GET URL:
https://api.aimapa.com/objects/1277273

{
    "object": {
        "address": "Україна, Сумська обл., місто Глухів, вулиця Києво-Московська, ",
        "aimap_classifier": "Будинки житлові котеджного типу",
        "aimap_id": "1277273",
        "consequence_class": "1",
        "date_added": "2021-01-11T00:00:00Z",
        "description": "Реконструкція житлового будинку з добудовою",
        "name": "Реконструкція житлового будинку з добудовою",
        "region": "Сумська",
        "stage_building": "дозволено",
        "stage_documentation": "зміна даних у декларації про початок будівельних робіт",
        "town": "місто Глухів"
    }
}