Документи одного eТТН

URI: /ettn/{{ettnUUID}}/documents

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

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

Параметри URI

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

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

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

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

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

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

Ім'я	Тип	Опис
0	object
0.actors	list[object]	Параметри осіб, приймаючих участь в перевезенні
0.actors.edrpou	string	Код ЄДРПОУ особи
0.actors.representative	list[object]
0.actors.representative.identification	list
0.actors.representative.name	string	ПІБ особи
0.actors.representative.role	string	Роль у перевезенні
0.actors.role	string	Роль у перевезенні
0.document	object	Дані документа
0.document.id	string	Ідентифікатор документа
0.document.mimeType	string	MIME типізація
0.document.signature	string	SHA-256 cheksum документа
0.document.size	integer	Розмір документа
0.document.url	string	Посилання на документ
0.document.version	integer	Номер поточної версії документа
0.id	string
0.signedBy	object	Дані підписанта документа
0.signedBy.edrpou	string	Код ЄДРПОУ підписанта
0.signedBy.representative	list[object]
0.signedBy.representative.identification	list
0.signedBy.representative.name	string	ПІБ підписанта
0.signedBy.representative.role	string	Роль в перевезенні
0.signedBy.role	string
0.status	string
0.storedDocument	object
0.storedDocument.id	string	Ідентифікатор документа
0.storedDocument.mimeType	string	MIME типізація
0.storedDocument.signature	string	SHA-256 cheksum документа
0.storedDocument.size	integer	Розмір документа
0.storedDocument.url	string	Посилання на документ
0.storedDocument.version	integer	Номер поточної версії документа
0.ticket	string	Квитанція
0.type	object
0.type.subtype	object
0.type.subtype.dict	string
0.type.subtype.value	string
0.type.type	string
status	integer

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

200 OK

Відповідь: /ettn/5a7738b1-ea5b-4c9d-b4e6-6864f7550232/documents

{
    "0": {
        "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": "PENDING_SIGNATURE",
        "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"
            },
            "type": "ACT"
        }
    },
    "status": 200
}