У цьому розділі описані запити для роботи зі справами, документами, звітами післяпроєктного моніторингу та громадськими слуханнями, пов'язаними з оцінкою впливу на довкілля.
Перелік справ ОВД
GET /api/v1/enterprises/{registry_id}/eia-cases
Цей запит повертає справи з оцінки впливу на довкілля, які пов'язані з підприємством. Разом із переліком справ повертаються основні дані по кожній справі, кількість документів, слухань і звітів післяпроєктного моніторингу, а також посилання на вкладені запити по кожній справі.
Параметр registry_id в адресі запиту є обов'язковим — це ідентифікатор підприємства.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/eia-cases" \
-H "Authorization: Bearer $ESG_API_TOKEN" \
-H 'Accept: application/json'
Приклад відповіді
Параметри пагінації
page: номер сторінки.
Поля відповіді
results.items[]
id: ідентифікатор справи.registry_id: реєстраційний номер справи.old_registry_id: реєстраційний номер справи зі старого реєстру ОВД. Якщо номер відсутній, повертаєтьсяnull.registry_type: тип реєстру ОВД, в якому ведеться справа:ЕкосистемаабоСтарий реєстр.status_id: ідентифікатор статусу справи ОВД. Доступні значення можна отримати в запиті Статуси справ ОВД.status_name: назва поточного статусу справи ОВД.authority_name: орган, який веде або оприлюднив справу.name: назва справи.address: адреса об'єкта справи.description: короткий опис справи.region: регіон справи.published_at: дата публікації справи.documents_count: кількість документів у справі.hearings_count: кількість громадських слухань.monitoring_reports_count: кількість звітів післяпроєктного моніторингу у справі.monitoring_status_id: ідентифікатор статусу післяпроєктного моніторингу.monitoring_status_name: назва статусу післяпроєктного моніторингу.monitoring_frequency: встановлена періодичність післяпроєктного моніторингу.last_monitoring_report: позначення останнього звіту післяпроєктного моніторингу.links.details: посилання на деталі справи ОВД.links.documents: посилання на документи конкретної справи.links.monitoring_reports: посилання на звіти післяпроєктного моніторингу конкретної справи.links.hearings: посилання на слухання конкретної справи.coordinates: координати адреси, якщо доступ до них дозволений для ключа.coordinates.latitude: широта.coordinates.longitude: довгота.
Деталі справи ОВД
GET /api/v1/enterprises/{registry_id}/eia-case-details/{case_id}
Цей запит повертає повні дані конкретної справи ОВД. У відповіді ви отримаєте той самий набір полів, що й у переліку справ, додатковий monitoring_comment, а також блок links для переходу до документів, звітів післяпроєктного моніторингу й слухань цієї справи.
Параметри registry_id і case_id в адресі запиту є обов'язковими. registry_id — це ідентифікатор підприємства. case_id — це ідентифікатор справи ОВД.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/eia-case-details/9132" \
-H "Authorization: Bearer $ESG_API_TOKEN" \
-H 'Accept: application/json'
Приклад відповіді
Поля відповіді
results.object
Поля об'єкта ті самі, що й у results.items[] в переліку справ ОВД. Поле monitoring_comment містить додатковий коментар щодо післяпроєктного моніторингу й повертається саме в деталях справи.
results.object.links
documents: посилання на документи цієї справи.monitoring_reports: посилання на звіти післяпроєктного моніторингу цієї справи.hearings: посилання на слухання цієї справи.
Документи ОВД підприємства
GET /api/v1/enterprises/{registry_id}/eia-documents
Цей запит повертає усі документи ОВД, пов'язані з підприємством. Разом із кожним документом повертається короткий блок case, який вказує, до якої справи належить кожен запис.
Параметр registry_id в адресі запиту є обов'язковим — це ідентифікатор підприємства.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/eia-documents?document_type_id=1" \
-H "Authorization: Bearer $ESG_API_TOKEN" \
-H 'Accept: application/json'
Приклад відповіді
Параметри пагінації
page: номер сторінки.
Фільтри
document_type_id: тип документа. Доступні значення можна отримати в запиті Типи документів ОВД.
Поля відповіді
results.items[]
id: ідентифікатор документа.registry_id: реєстраційний номер документа.type_id: ідентифікатор типу документа.type_name: назва типу документа.name: назва файла документа.format: формат файла.size: розмір файла в байтах.uploaded_at: дата, коли файл було завантажено або оприлюднено в джерелі.downloaded_at: дата, коли файл був завантажений у систему ESG SaveEcoBot.links.download: посилання на завантаження документа.links.receipt: посилання на PDF-квитанцію цього документа.case: коротка інформація про справу, до якої належить документ.case.id: ідентифікатор справи.case.registry_id: реєстраційний номер справи.case.old_registry_id: реєстраційний номер справи зі старого реєстру ОВД.case.registry_type: тип реєстру ОВД:ЕкосистемаабоСтарий реєстр.case.status_id: ідентифікатор статусу справи ОВД.case.status_name: назва поточного статусу справи ОВД.case.authority_name: орган по справі.case.name: назва справи.case.address: адреса об'єкта справи.case.region: регіон справи.case.published_at: дата публікації справи.
Завантаження документа ОВД
GET /api/v1/enterprises/{registry_id}/eia-documents/{document_id}/download
Цей запит повертає бінарний файл документа ОВД для завантаження.
Параметри registry_id і document_id в адресі запиту є обов'язковими. registry_id — це ідентифікатор підприємства. document_id — це ідентифікатор документа ОВД.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl -L "https://esg.saveecobot.com/api/v1/enterprises/00178353/eia-documents/79733/download" \
-H "Authorization: Bearer $ESG_API_TOKEN"
Приклад відповіді
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="eia-document.pdf"
Квитанція документа ОВД
GET /api/v1/enterprises/{registry_id}/eia-documents/{document_id}/receipt
Цей запит повертає PDF-квитанцію для документа ОВД. Параметри registry_id і document_id відповідають значенням із переліку документів ОВД.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl -L "https://esg.saveecobot.com/api/v1/enterprises/00178353/eia-documents/79733/receipt" \
-H "Authorization: Bearer $ESG_API_TOKEN"
Приклад відповіді
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="ESG_SaveEcoBot_Document_Receipt.pdf"
Оригінал і квитанція мають спільну тарифну ідентичність документа.
Звіти післяпроєктного моніторингу ОВД підприємства
GET /api/v1/enterprises/{registry_id}/eia-monitoring-reports
Цей запит повертає звіти післяпроєктного моніторингу, пов'язані зі справами ОВД підприємства. Результат має посторінкову навігацію.
Параметр registry_id в адресі запиту є обов'язковим. Необов'язковий параметр page визначає номер сторінки.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/14226133/eia-monitoring-reports?page=1" \
-H "Authorization: Bearer $ESG_API_TOKEN" \
-H 'Accept: application/json'
Приклад відповіді
Поля відповіді
results.items[].id: ідентифікатор звіту післяпроєктного моніторингу.results.items[].name: назва звіту.results.items[].date: дата звіту, якщо вона відома.results.items[].year: рік звітного періоду.results.items[].quarter: квартал звітного періоду, якщо він визначений.results.items[].period: текстовий опис звітного періоду.results.items[].authority_name: орган, який оприлюднив або веде звіт.results.items[].region: регіон звіту.results.items[].files_count: кількість доступних файлів звіту.results.items[].links.download: посилання на завантаження основного файла.results.items[].links.receipt: посилання на PDF-квитанцію основного файла.results.items[].cases: справи ОВД, з якими пов'язаний звіт.
Завантаження звіту післяпроєктного моніторингу ОВД
GET /api/v1/enterprises/{registry_id}/eia-monitoring-reports/{report_id}/download
Цей запит повертає основний файл звіту післяпроєктного моніторингу ОВД.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl -L "https://esg.saveecobot.com/api/v1/enterprises/14226133/eia-monitoring-reports/12/download" \
-H "Authorization: Bearer $ESG_API_TOKEN"
Квитанція звіту післяпроєктного моніторингу ОВД
GET /api/v1/enterprises/{registry_id}/eia-monitoring-reports/{report_id}/receipt
Цей запит повертає PDF-квитанцію для основного файла звіту післяпроєктного моніторингу ОВД.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl -L "https://esg.saveecobot.com/api/v1/enterprises/14226133/eia-monitoring-reports/12/receipt" \
-H "Authorization: Bearer $ESG_API_TOKEN"
Оригінал і квитанція мають спільну тарифну ідентичність документа.
Слухання ОВД підприємства
GET /api/v1/enterprises/{registry_id}/eia-hearings
Цей запит повертає громадські слухання по справах ОВД. Разом із переліком слухань повертається короткий блок case, який вказує, до якої справи належить кожен запис.
Параметр registry_id в адресі запиту є обов'язковим — це ідентифікатор підприємства.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/24584661/eia-hearings" \
-H "Authorization: Bearer $ESG_API_TOKEN" \
-H 'Accept: application/json'
Приклад відповіді
Параметри пагінації
page: номер сторінки.
Поля відповіді
results.items[]
id: ідентифікатор слухання.datetime: дата й час слухання.url: посилання на громадські слухання у разі проведення онлайн.address: адреса проведення слухання.comments: додаткові коментарі.case: коротка інформація про справу, до якої належить слухання.case.id: ідентифікатор справи.case.registry_id: реєстраційний номер справи.case.old_registry_id: реєстраційний номер справи зі старого реєстру ОВД.case.registry_type: тип реєстру ОВД:ЕкосистемаабоСтарий реєстр.case.status_id: ідентифікатор статусу справи ОВД.case.status_name: назва поточного статусу справи ОВД.case.authority_name: орган по справі.case.name: назва справи.case.address: адреса об'єкта справи.case.region: регіон справи.case.published_at: дата публікації справи.case.monitoring_status_id: ідентифікатор статусу післяпроєктного моніторингу.case.monitoring_status_name: назва статусу післяпроєктного моніторингу.case.monitoring_frequency: встановлена періодичність післяпроєктного моніторингу.case.last_monitoring_report: позначення останнього звіту післяпроєктного моніторингу.
Документи справи ОВД
GET /api/v1/enterprises/{registry_id}/eia-cases/{case_id}/documents
Цей запит повертає документи конкретної справи ОВД. Разом із переліком документів повертається блок object з короткою інформацією про саму справу.
Параметри registry_id і case_id в адресі запиту є обов'язковими. registry_id — це ідентифікатор підприємства. case_id — це ідентифікатор справи ОВД.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/eia-cases/9132/documents?document_type_id=1" \
-H "Authorization: Bearer $ESG_API_TOKEN" \
-H 'Accept: application/json'
Приклад відповіді
Фільтри
document_type_id: тип документа. Доступні значення можна отримати в запиті Типи документів ОВД.
Поля відповіді
results.object
id: ідентифікатор справи.registry_id: реєстраційний номер справи.old_registry_id: реєстраційний номер справи зі старого реєстру ОВД.registry_type: тип реєстру ОВД:ЕкосистемаабоСтарий реєстр.status_id: ідентифікатор статусу справи ОВД.status_name: назва поточного статусу справи ОВД.authority_name: орган, який веде або оприлюднив справу.name: назва справи.address: адреса об'єкта справи.region: регіон справи.published_at: дата публікації справи.monitoring_status_id: ідентифікатор статусу післяпроєктного моніторингу.monitoring_status_name: назва статусу післяпроєктного моніторингу.monitoring_frequency: встановлена періодичність післяпроєктного моніторингу.last_monitoring_report: позначення останнього звіту післяпроєктного моніторингу.
results.items[]
Поля елемента ті самі, що й у глобальному списку документів, але без вкладеного object.
Слухання у справі ОВД
GET /api/v1/enterprises/{registry_id}/eia-cases/{case_id}/hearings
Цей запит повертає слухання конкретної справи ОВД. Разом із переліком слухань повертається блок object з короткою інформацією про саму справу.
Параметри registry_id і case_id в адресі запиту є обов'язковими. registry_id — це ідентифікатор підприємства. case_id — це ідентифікатор справи ОВД.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/eia-cases/9132/hearings" \
-H "Authorization: Bearer $ESG_API_TOKEN" \
-H 'Accept: application/json'
Приклад відповіді
Поля відповіді
results.object
id: ідентифікатор справи.registry_id: реєстраційний номер справи.old_registry_id: реєстраційний номер справи зі старого реєстру ОВД.registry_type: тип реєстру ОВД:ЕкосистемаабоСтарий реєстр.status_id: ідентифікатор статусу справи ОВД.status_name: назва поточного статусу справи ОВД.authority_name: орган, який веде або оприлюднив справу.name: назва справи.address: адреса об'єкта справи.region: регіон справи.published_at: дата публікації справи.monitoring_status_id: ідентифікатор статусу післяпроєктного моніторингу.monitoring_status_name: назва статусу післяпроєктного моніторингу.monitoring_frequency: встановлена періодичність післяпроєктного моніторингу.last_monitoring_report: позначення останнього звіту післяпроєктного моніторингу.
results.items[]
Поля елемента ті самі, що й у глобальному списку слухань, але без вкладеного object.
Звіти післяпроєктного моніторингу окремої справи ОВД
GET /api/v1/enterprises/{registry_id}/eia-cases/{case_id}/monitoring-reports
Цей запит повертає всі звіти післяпроєктного моніторингу, пов'язані з конкретною справою ОВД. Блок object містить короткі дані справи, а items має ту саму структуру звіту, що й загальний перелік, але без вкладеного масиву cases.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/14226133/eia-cases/2161/monitoring-reports" \
-H "Authorization: Bearer $ESG_API_TOKEN" \
-H 'Accept: application/json'
Приклад відповіді
Поля відповіді
results.object: короткі дані справи ОВД, включно зі статусом і періодичністю післяпроєктного моніторингу.results.items[]: звіти післяпроєктного моніторингу цієї справи без вкладеного масивуcases.