Інформація про документ

URI: /document/{{documentUUID}}

Використовується для отримання інформації про документ.

Запит виконується методом GET у json форматі з даними.

Параметри URI

Метод дозволяє передати наступні параметри:

/document/{{documentUUID}}, де:

• documentUUID — унікальний ідентифікатор (UUID) документа.

Параметри запиту

Ім'я	Тип	Обов.	Опис
offset	integer	Ні	Початковий номер, з якого необхідно виводити записи
limit	integer	Ні	Кількість рядків на сторінці

Параметри відповіді

Ім'я	Тип	Опис
actors	list[object]	Параметри осіб, які приймають участь в перевезенні
actors.edrpou	string	Код ЄДРПОУ особи
actors.representative	list[object]
actors.representative.identification	list
actors.representative.name	string	ПІБ особи
actors.representative.role	string	Роль у перевезенні
actors.role	string
document	object
document.id	string
document.mimeType	string
document.signature	string
document.size	integer
document.url	string
document.version	integer
id	string
signedBy	object	Дані підписанта документа
signedBy.edrpou	string	Код ЄДРПОУ підписанта
signedBy.representative	list[object]
signedBy.representative.identification	list
signedBy.representative.name	string	ПІБ підписанта
signedBy.representative.role	string	Роль в перевезенні
signedBy.role	string
status	integer	HTTP код
storedDocument	object	Збережений документа
storedDocument.id	string	Ідентифікатор документа
storedDocument.mimeType	string	Тип медіа
storedDocument.origin	string
storedDocument.signature	string	Підпис документа
storedDocument.size	integer	Розмір документа
storedDocument.url	string	Посилання на документ
storedDocument.version	integer	Версія документа
ticket	string
type	object
type.subtype	object
type.subtype.dict	string
type.subtype.value	string
type.subtype.name	string
type.type	string
error	object	Параметри помилки
error.ettn_api_error	boolean	Прапор помилки
error.code	integer	Код помилики
error.details	string	Текст помилки
error.message	string	Повідомлення для користувача
error.explanation	string	Опис помилки

Приклад успішної відповіді

200 OK

Відповідь: /document/b338f5ce-63cb-44ab-aa78-d6bbf145ea0a

{
    "actors": [
        {
            "edrpou": "2884700372",
            "representative": [
                {
                    "identification": [],
                    "name": "ІВАНОВ ІВАН ІВАНОВИЧ",
                    "role": "4"
                }
            ],
            "role": "CARRIER"
        }
    ],
    "document": {
        "id": "b338f5ce-63cb-44ab-aa78-d6bbf145ea0a",
        "mimeType": "application/xml",
        "signature": "MIIlJwYJKoZIhvcNAQcC***U8Xm9gSzuvw4P7wsFTk=",
        "size": 15573,
        "url": "https://ettn-dev.phrm.pro/api/v1/ettn/download/?q=temp/651520db7d41b3e1ca085d63/ACT-0.xml",
        "version": 0
    },
    "id": "5a7738b1-ea5b-4c9d-b4e6-6864f7550232",
    "signedBy": {
        "edrpou": "2884700372",
        "representative": [
            {
                "identification": [],
                "name": "ІВАНОВ ІВАН ІВАНОВИЧ",
                "role": "4"
            }
        ],
        "role": "CARRIER"
    },
    "status": 200,
    "storedDocument": {
        "id": "b338f5ce-63cb-44ab-aa78-d6bbf145ea0a",
        "mimeType": "application/xml",
        "signature": "MIIlJwYJKoZIhvcNAQcC***U8Xm9gSzuvw4P7wsFTk=",
        "size": 15573,
        "url": "https://stage.ettn.wilded.io/api/2/document/b338f5ce-63cb-44ab-aa78-d6bbf145ea0a",
        "version": 0
    },
    "ticket": "eyJhbGciOiJIUzI1NiIs***6fwlOvEnvUe-1P5UHdMY",
    "type": {
        "subtype": {
            "dict": "01.09",
            "value": "7",
            "name": "Акт примусового завершення е-ТТН"
        },
        "type": "ACT"
    }
}

Приклад неуспішної відповіді

500 Internal Server Error

Відповідь: /document/b338f5ce-63cb-44ab-aa78-d6bbf145ea0a

{
    "error": {
        "ettn_api_error": true,
        "code": 0,
        "details": "[Failed to convert value of type 'java.lang.String' to required type 'java.util.UUID'; UUID string too large]",
        "message": "Внутрішня помилка ЦБД",
        "explanation": "Виникає у разі непередбачених специфікацією проблем. Зверніться у підтримку ЦБД."
    },
    "status": 500
}