Документація API PMAP

Тестовий ключ доступу access-token: 59444c51-1c47-4ae8-b018-da0357362293. Обмеження кількості запитів для тестового ключа 2 запити за секунду.

Для використання API PMAP напишіть лист в технічну підтримку на цю адресу o.pilat@brdo.com.ua для отримання ключа доступу.

Приклад запиту

GET https://pmap.minregion.gov.ua/index.php?r=api/document&access-token=59444c51-1c47-4ae8-b018-da0357362293

Формати відповіді

json, xml. Формат вказується при запиті в HTTP-заголовку Accept: application/json або Accept: application/xml

Опис полів

  • uuid Ідентифікатор документу.
  • ato_type Тип АТО.
  • ato_name Назва АТО.
  • koatuu КОАТУУ.
  • document_type Тип документу (Інше; Генеральний план; Детальний план території; План зонування території; Схема планування окремих частин території України; Схема планування території АРК; Схема планування території області; Схема планування території району; Схема планування території, на якій реалізуються повноваження сільських, селищних, міських рад).
  • name Назва рішення про затвердження.
  • date_approval Дата затвердження.
  • decision_number Номер рішення про затвердження.
  • link_decision Лінк.
  • link_text Лінк 2.
  • link_graphic Лінк 3.
  • percentage_coverage Відсоток покриття.
  • info_territory Інформація про територію ДПТ.
  • zoning_plan План зонування території у складі генерального плану.
  • additional_info Додаткова інформація.
  • updated_at Дата оновлення документу.

Опис заголовків відповіді

  • x-pagination-current-page Поточна сторінка.
  • x-pagination-page-count Загальна кількість сторінок.
  • x-pagination-per-page Кількість записів на сторінці.
  • x-pagination-total-count Загальна кількість записів.
  • x-rate-limit-limit Максимальна кількість запитів, дозволена протягом періоду часу.
  • x-rate-limit-remaining Кількість запитів, яка залишилась в поточному періоді часу.
  • x-rate-limit-reset Кількість секунд, яких залишилось чекати до отримання максимальної кількості дозволених запитів.

Дозволені параметри для пошуку

  • uuid Ідентифікатор документу. Наприклад: отримати інформацію по списку документів з конкретними uuid filter[uuid][in][]=uuid_1[uuid][in][]=uuid_2 (uuid in (uuid_1, uuid_2)).
  • koatuu КОАТУУ. Наприклад: отримати документацію по АТО з КОАТУУ 0524587903, filter[koatuu]=0524587903, або документацію по списку АТО.
  • updated_at Дата оновлення документу. Наприклад: отримати всі документи які були оновлені після дати 2018-09-23, filter[updated_at][>]=2018-09-23.
  • document_type Тип документу. Наприклад: отримати генеральні плани filter[document_type][like]=генеральний план.
  • decision_number Номер рішення. Наприклад: Отримати документи, в яких номер рішення про затвердження рівний 1234.

Ці параметри можна міксувати в запиті. Для більш детальної інформації як будувати запити можна глянути тут https://www.yiiframework.com/doc/api/2.0/yii-data-datafilter .

Список параметрів для пошуку може бути розширений. Для цього зверніться в технічну підтримку PMAP за цією адресою o.pilat@brdo.com.ua.

Приклади

  • https://pmap.minregion.gov.ua/index.php?r=api/document&access-token=59444c51-1c47-4ae8-b018-da0357362293&page=2 Отримати сторінку номер 2.
  • https://pmap.minregion.gov.ua/index.php?r=api/document&access-token=59444c51-1c47-4ae8-b018-da0357362293&filter[koatuu]=8000000000 Отримати всі документи по місті Києві.
  • https://pmap.minregion.gov.ua/index.php?r=api/document&access-token=59444c51-1c47-4ae8-b018-da0357362293&filter[ato_name]=Коростишівський Район Отримати містобудівну документацію по Коростишівському районі.
  • https://pmap.minregion.gov.ua/index.php?r=api/document&access-token=59444c51-1c47-4ae8-b018-da0357362293&filter[and][][date_approval][>]=1995-01-01&filter[and][][date_approval][<]=2000-01-01&filter[and][][document_type]=Генеральний план Отримати всі генеральні плани з 1995-01-01 по 2000-01-01.
  • https://pmap.minregion.gov.ua/index.php?r=api/document&access-token=59444c51-1c47-4ae8-b018-da0357362293&filter[koatuu][in][]=5910100000&filter[uuid][in][]=5910500000 Отримати містобудівну документацію по місті Суми та місті Лебедин.
  • https://pmap.minregion.gov.ua/index.php?r=api/document&access-token=59444c51-1c47-4ae8-b018-da0357362293&filter[updated_at][>]=2019-07-03 Отримати всі документи, які оновились після 2019-07-03.