Інформація про eТТН

URI: /ettn/info/{{ettnUUID}}

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

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

Параметри URI

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

/ettn/info/{{ettnUUID}}, де:

• ettnUUID — унікальний ідентифікатор (UUID) eТТН.

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

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

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

Ім'я	Тип	Опис
document	object	Дані документа
document.id	string	Ідентифікатор документа
document.mimeType	string	MIME типізація
document.origin	string	Номер версії документа, на основі якої створений даний документ
document.signature	string	SHA-256 cheksum документа
document.size	integer	Розмір документа
document.url	string	Посилання на документ
document.version	integer	Версія документа
id	string
payload	object
payload.actors	list[object]	Параметри осіб, приймаючих участь в перевезенні
payload.actors.edrpou	string	Код ЄДРПОУ особи
payload.actors.representative	list[object]
payload.actors.representative.identification	list
payload.actors.representative.name	string	ПІБ особи
payload.actors.representative.role	string	Роль у перевезенні
payload.actors.role	string
payload.internalId	string
payload.places	list[object]	Параметри місць завантаження або розвантаження
payload.places.koatg	string	Реєстраційний код об'єкта адміністративно-територіального устрою України
payload.places.type	string	Тип місця
payload.tonnage	integer
payload.transports	list[object]	Параметри транспорту
payload.transports.country	string	Країна реєстрації транспорту
payload.transports.tn	string	Реєстраційний номер транспорту
payload.transports.type	string	Тип транспорту
payload.type	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	string
error	object	Параметри помилки
error.ettn_api_error	boolean	Прапор помилки
error.code	integer	Код помилки
error.details	string	Текст помилки
error.message	string	Повідомлення для користувача
error.explanation	string	Опис помилки

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

200 OK

Відповідь: /ettn/info/bdef33cd-e9e9-45a9-8e8a-a8e944b590e3

{
    "document": {
        "id": "bdef33cd-e9e9-45a9-8e8a-a8e944b590e3",
        "mimeType": "application/xml",
        "origin": "ea272bbe-8850-4b35-940a-d0721cc4f254",
        "signature": "MIIlJwYJKoZIhvcNAQcC***U8Xm9gSzuvw4P7wsFTk=",
        "size": 19947,
        "url": "https://ettn-dev.phrm.pro/api/v1/ettn/download/?q=temp/651520db7d41b3e1ca085d63/730-2.xml",
        "version": 2
    },
    "id": "8cc856c8-c3fe-4eaa-a6a3-ed0d146c1c7a",
    "payload": {
        "actors": [
            {
                "edrpou": "2884700372",
                "representative": [
                    {
                        "identification": [],
                        "name": "ОБУХОВ ВІТАЛІЙ ЛЕОНІДОВИЧ",
                        "role": "2"
                    }
                ],
                "role": "CARRIER"
            }
        ],
        "internalId": "01/001",
        "places": [
            {
                "koatg": "UA01020010010075540",
                "type": "LOAD"
            }
        ],
        "tonnage": 20,
        "transports": [
            {
                "country": "UK",
                "tn": "АА1234ВВ",
                "type": "2"
            },
            {
                "country": "UK",
                "tn": "АА1234ВВ",
                "type": "4"
            }
        ],
        "type": "GENERIC"
    },
    "signedBy": {
        "edrpou": "2884700372",
        "representative": [
            {
                "identification": [],
                "name": "ОБУХОВ ВІТАЛІЙ ЛЕОНІДОВИЧ",
                "role": "4"
            }
        ],
        "role": "CARRIER"
    },
    "status": 200,
    "storedDocument": {
        "id": "bdef33cd-e9e9-45a9-8e8a-a8e944b590e3",
        "mimeType": "application/xml",
        "origin": "ea272bbe-8850-4b35-940a-d0721cc4f254",
        "signature": "MIIlJwYJKoZIhvcNAQcC***U8Xm9gSzuvw4P7wsFTk=",
        "size": 19947,
        "url": "https://stage.ettn.wilded.io/api/2/document/bdef33cd-e9e9-45a9-8e8a-a8e944b590e3",
        "version": 2
    },
    "ticket": "eyJhbGciOiJIUzI1NiIs***uRis0ah5MR_vWqgmqE_M",
    "type": "GENERIC"
}

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

500 Internal Server Error

Відповідь: /ettn/info/bdef33cd-e9e9-45a9-8e8a-a8e944b590e3

{
    "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
}