Відкритий API
З 31 грудня 2020 року модернізований Реєстр декларацій впроваджено в постійну експлуатацію. Серед оновлень відкритого АРІ:
- дані кроків замість масивів ['data']['step_<0..16>'] знаходяться у масивах ['data']['step_<0..17>']['data'];
- поле ['lastmodified_date'] перейменовано у ['date'];
- поле ['created_date'] прибрано;
- дані з кроку 2.1 декларації (['postType'], ['postCategory'], ['responsiblePosition'], ['corruptionAffected']) продубльовано на верхньому рівні у відповідних полях ['responsible_position'], ['post_type'], ['post_category']( порядковий номер з довідника), ['corruption_affected'];
- дані з кроку 1 (['declarationType']) продубльовано на верхньому рівні у полі ['declaration_type'];
- у полі ['declaration_year'] зазначено звітній період декларації.
Дані про подані декларації доступні у машинозчитуваному форматі JSON.
Приклад запиту:
де: "210f5cfe-d5e9-4af8-8b6c-226b2eba6819" – унікальний ідентифікатор документа {document_id}.
При запиті неіснуючого документа буде повернуто JSON {error: 1310002}.
При запиті неіснуючої сторінки буде повернуто JSON {error: 404}.
Також наявна можливість фільтрації та пошуку, використовуючи необов’язкові GET-параметри.
Приклад запиту:
Необов’язкові GET-параметри:
- query – поле "Пошуковий запит", текстове, від 3 до 255 символів. При невідповідності довжини повертає помилку JSON {error: 1310101}. При існуванні цього поля сортування буде йти по релевантності, а не по даті подання;
- user_declarant_id – поле "ID суб’єкта декларування", числове, від 1 до 10000000. При невідповідності заповнення повертає помилку JSON {error: 1310111} або JSON {error: 1310112};
- document_type – поле "Тип документа", числове, від 1 до 3. При невідповідності заповнення повертає помилку JSON {error: 1310121} або JSON {error: 1310122};
- declaration_type – поле "Тип декларації", числове, від 1 до 4. При невідповідності заповнення повертає помилку JSON {error: 1310131} або JSON {error: 1310132};
- declaration_year – поле "Рік декларації", числове, від 2015 до поточного року. При невідповідності заповнення повертає помилку JSON {error: 1310141} або JSON {error: 1310142};
- start_date – поле "Початок дати подання", числове, від 1470009600 (01.08.2016) до поточної дати у секундах від початку епохи UNIX. При невідповідності заповнення повертає помилку JSON {error: 1310151} або JSON {error: 1310152};
- end_date – поле "Кінець дати подання", числове, від 1470009600 (01.08.2016) до поточної дати у секундах від початку епохи UNIX. При невідповідності заповнення повертає помилку JSON {error: 1310161} або JSON {error: 1310162};
- page – поле "№ сторінки" для пересування по сторінках, якщо кількість результатів перевищує 100, числове, від 1 до 100. При невідповідності заповнення повертає помилку JSON {error: 1310171} або JSON {error: 1310172}.