У цьому розділі описані запити для роботи з дозволами, ліцензіями, деклараціями та висновками підприємства в межах конкретного домену, а також з пов'язаними файлами. Далі для стислості в описі використовується термін дозволи.
Перелік дозволів
GET /api/v1/enterprises/{registry_id}/permissions/{domain}
Цей запит повертає дозволи підприємства в межах одного домену. У відповіді ви отримаєте основні реквізити дозволу, строки дії, статус, посилання на файли та, якщо доступ дозволений, координати об'єкта.
Параметри registry_id і domain в адресі запиту є обов'язковими. registry_id — це ідентифікатор підприємства.
Доступні значення domain можна отримати в запиті Домени даних.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/permissions/air?permission_type_id=1" \
-H "Authorization: Bearer $ESG_API_TOKEN" \
-H 'Accept: application/json'
Приклад відповіді
Параметри пагінації
page: номер сторінки.
Фільтри
permission_type_id: ідентифікатор типу дозволу. Доступні значення можна отримати в запиті Типи дозволів.
Поля відповіді
results.items[]
id: ідентифікатор дозволу.type_id: ідентифікатор типу дозволу.type_name: назва типу дозволу.registry_id: номер дозволу або реєстраційний номер. Якщо номер відсутній, повертаєтьсяnull.authority_name: орган видачі дозволу.name: назва дозволу або промислового майданчику.subtypes[]: перелік підтипів дозволу, якщо вони є.description_lines[]: короткий опис дозволу у вигляді окремих рядків.address: адреса, пов'язана з дозволом, наприклад, адреса промислового майданчику.region: регіон, до якого належить дозвіл.status: текстовий статус дозволу.status_synced_at: дата останнього оновлення статусу з джерела/реєстра.notes: додаткові примітки по дозволу.issued_at: дата видачі, якщо вона є.valid_from: дата початку дії, якщо вона є.valid_to: дата завершення дії, якщо вона є.is_active: ознака чинності дозволу.files_count: кількість пов'язаних файлів.links.details: посилання на деталі дозволу.links.files: посилання на окремий запит зі списком файлів.coordinates: координати адреси, якщо доступ до них дозволений для ключа.coordinates.latitude: широта.coordinates.longitude: довгота.
Деталі дозволу
GET /api/v1/enterprises/{registry_id}/permission-details/{permission_id}
Цей запит повертає повні дані конкретного дозволу. У відповіді ви отримаєте той самий набір полів, що й у переліку дозволів, а також блок links для переходу до пов'язаних файлів.
Параметри registry_id і permission_id в адресі запиту є обов'язковими. registry_id — це ідентифікатор підприємства. permission_id — це ідентифікатор дозволу.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/permission-details/147" \
-H "Authorization: Bearer $ESG_API_TOKEN" \
-H 'Accept: application/json'
Приклад відповіді
Поля відповіді
results.object
Поля об'єкта ті самі, що й у results.items[] в переліку дозволів.
results.object.links
files: посилання на окремий перелік файлів дозволу, якщо файли є.
Файли дозволу
GET /api/v1/enterprises/{registry_id}/permission-files/{permission_id}
Цей запит повертає файли конкретного дозволу. Разом із переліком файлів items повертається блок object з короткою інформацією про дозвіл.
Параметри registry_id і permission_id в адресі запиту є обов'язковими. registry_id — це ідентифікатор підприємства. permission_id — це ідентифікатор дозволу.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/permission-files/147" \
-H "Authorization: Bearer $ESG_API_TOKEN" \
-H 'Accept: application/json'
Приклад відповіді
Поля відповіді
results.object
type: тип об'єкта. Для цього запиту використовується значенняpermission.id: ідентифікатор дозволу.registry_id: номер дозволу або реєстраційний номер.type_id: ідентифікатор типу дозволу.type_name: назва типу дозволу.name: назва дозволу.
results.items[]
id: ідентифікатор файла дозволу.type_name: назва типу документа або файла.name: назва файла.description: короткий опис файла.format: формат файла, наприкладpdfабоdocx.size: розмір файла в байтах.uploaded_at: дата, коли файл було завантажено або оприлюднено в джерелі.downloaded_at: дата, коли файл був завантажений у систему ESG SaveEcoBot.links.download: посилання на завантаження файла.
Завантаження файла дозволу
GET /api/v1/enterprises/{registry_id}/permission-files/{permission_id}/download/{file_id}
Цей запит повертає бінарний файл дозволу для завантаження.
Параметри registry_id, permission_id і file_id в адресі запиту є обов'язковими. registry_id — це ідентифікатор підприємства. permission_id — це ідентифікатор дозволу. file_id — це ідентифікатор файла дозволу.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl -L "https://esg.saveecobot.com/api/v1/enterprises/00178353/permission-files/147/download/1" \
-H "Authorization: Bearer $ESG_API_TOKEN"
Приклад відповіді
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="permit.pdf"