Створення eТТН

URI: /domain/api/v1/ettn/

Для створення eТТН виконується метод /domain/api/v1/ettn/.

Запит виконується методом POST.

Приклад запиту

Запит: /domain/api/v1/ettn/

{
    Xml eТТН
}

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

Ім'я	Тип	Опис
ettnID	string	Ідентифікатор eТТН
cbdID	string	Ідентифікатор eТТН в ЦБД

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

Відповідь: /domain/api/v1/ettn/

{
  "ettnID": "645b50f79d81428162007a02",
  "cbdID": "645b50f79d81428162007a02",
}

Отримати поточний стан реєстрації eТТН в ЦБД

Для отримання поточного стану реєстрації eТТН в ЦБД виконується метод /domain/api/v1/ettn/{ettnID}.

Запит виконується методом GET.

URI: /domain/api/v1/ettn/{ettnID}

Параметри URI

Метод дозволяє передати ідентифікатор eТТН, у вигляді:

/domain/api/v1/ettn/{ettnID}, де {ettnID} — ідентифікатор eТТН отриманий в запиті /domain/api/v1/ettn/.

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

Ім'я	Тип	Обов'язковий	Опис
ettnID	string	Так	ID eТТН отриманий запитом /domain/api/v1/ettn/

Приклад запиту

/domain/api/v1/ettn/645b50f79d81428162007a02

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

Ім'я	Тип	Опис
message	string	Містить повідомлення з поточним станом реєстрації eТТН в ЦБД
error	list[object]	Містить повідомлення про помилки
error.ram:SpecifiedTransactionID	string	Не вказано ідентифікатор

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

200 OK

Відповідь: /domain/api/v1/ettn/{ettnID}

{
    "message": "Ok"
}

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

В запиті не вказаний TransactionID

422 Unprocessable Entity (WebDAV) (RFC 4918)

Відповідь: /domain/api/v1/ettn/{ettnID}

{
  "errors": 
  [
    {"ram:SpecifiedTransactionID": "текст"},
    {"ram:SpecifiedTransactionID": "текст"}
  ]
}

Відміна eТТН

Для відміни eТТН виконується метод /domain/api/v1/ettn/{ettnID}.

Запит виконується методом PATCH.

URI: /domain/api/v1/ettn/{ettnID}

Параметри URI

Метод дозволяє передати ідентифікатор eТТН, у вигляді:

/domain/api/v1/ettn/{ettnID}, де {ettnID} — ID eТТН отриманий запитом /domain/api/v1/ettn/`.

Приклад запиту

/domain/api/v1/ettn/645b50f79d81428162007a02

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

Ім'я	Тип	Опис
message	string	Містить повідомлення з результатом виконання запиту
error	list[object]	Містить повідомлення про помилки
error.ettnID	string	Немає доступу для видалення eТТН

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

200 OK

Відповідь: //domain/api/v1/ettn/{ettnID}

{
    "message": "Ok"
}

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

Немає доступу для видалення eТТН

422 Unprocessable Entity (WebDAV) (RFC 4918)

Відповідь: /domain/api/v1/ettn/{ettnID}

{
  "error": 
  [
    {
      "ettnID": "У Вас нету доступа ЕТТН для удаления"
    }
  ]
}

Реєстрація наступної версії підписання документа eТТН

Для реєстрації наступної версії підписання документа eТТН виконується метод /domain/api/v1/ettn/{ettnID}.

Запит виконується методом POST.

URI: /domain/api/v1/ettn/{ettnID}

Параметри URI

Метод дозволяє передати ідентифікатор eТТН, у вигляді:

/domain/api/v1/ettn/{ettnID}, де {ettnID} — ID eТТН отриманий запитом /domain/api/v1/ettn/.

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

Ім'я	Тип	Обов'язковий	Опис
ettnID	string	Так	ID eТТН отриманий запитом /domain/api/v1/ettn/

Приклад запиту

Запит: /domain/api/v1/ettn/{ettnID}

{
    Xml eТТН
}

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

Ім'я	Тип	Опис
message	string	Містить повідомлення з результатом виконання запиту
error	list[object]	Містить повідомлення про помилки
error.ram:SpecifiedTransactionID	string	Не вказано ідентифікатор

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

200 OK

Відповідь: /domain/api/v1/ettn/{ettnID}

{
    "message": "Ok"
}

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

В запиті не вказаний TransactionID

422 Unprocessable Entity (WebDAV) (RFC 4918)

Відповідь: /domain/api/v1/ettn/{ettnID}

{
  "errors": 
  [
    {"ram:SpecifiedTransactionID": "текст"},
    {"ram:SpecifiedTransactionID": "текст"}
  ]
}

Отримати супровідну документацію по eТТН

Для отримання супровідної документації по eТТН виконується метод /domain/api/v1/ettn/{ettnID}/refdoc.

Запит виконується методом GET.

URI: /domain/api/v1/ettn/{ettnID}/refdoc

Параметри URI

Метод дозволяє передати ідентифікатор eТТН, у вигляді:

/domain/api/v1/ettn/{ettnID}/refdoc, де {ettnID} — ID eТТН отриманий запитом /domain/api/v1/ettn/.

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

Ім'я	Тип	Обов'язковий	Опис
ettnID	string	Так	ID eТТН отриманий запитом /domain/api/v1/ettn/

Приклад запиту

Запит: /domain/api/v1/ettn/{ettnID}/refdoc

{
    Xml eТТН
}

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

Ім'я	Тип	Опис
document	object	Містить параметри супровідної документації по eТТН
document.mimeType	string	MIME Тип документа
document.size	integer	Розмір документа
document.url	string	Посилання на документ
document.signature	string	Підпис документа
document.version	string	Версія документа
document.origin	string	Походження документа
type	object	Містить параметри типа документа
type.type	string	Тип документа
type.subtype	object
type.subtype.dict	string
type.subtype.value	string
signedBy	object	Параметри підписанта документа
signedBy.edrpou	string	ЄДРПОУ підписанта
signedBy.role	string	Роль підписанта
signedBy.representative	list[object]	Загальні параметри підписанта
signedBy.representative.name	string	Ім'я підписанта документа
signedBy.representative.role	string	Роль підписанта документа
signedBy.representative.identification	list[object]	Містить параметри документа підтверджуючого особу підписанта документа
signedBy.representative.identification.type	string	Тип документа підтверджуючого особу підписанта документа
signedBy.representative.identification.series	string	Серія документа підтверджуючого особу підписанта документа
signedBy.representative.identification.seriesNo	string	Номер документа підтверджуючого особу підписанта документа
signedBy.representative.identification.expires	string	Строк дії документа підтверджуючого особу підписанта документа
signedBy.representative.signatureRequired	boolean	Вказується чи підпис підписанта обов'язковий
actors	list[object]	Параметри дійової особи
actors.edrpou	string	ЄДРПОУ дійової особи
actors.role	string	Роль дійової особи
actors.representative	list[object]	Загальні параметри дійової особи
actors.representative.name	string	Ім'я дійової особи
actors.representative.role	string	Роль дійової особи
actors.representative.identification	list[object]	Містить параметри документа підтверджуючого особу
actors.representative.identification.type	string	Тип документа підтверджуючого особу
actors.representative.identification.series	string	Серія документа підтверджуючого особу
actors.representative.identification.seriesNo	string	Номер документа підтверджуючого особу
actors.representative.identification.expires	string	Строк дії документа підтверджуючого особу
actors.representative.signatureRequired	boolean	Вказується чи підпис дійової особи обов'язковий
error	list[object]	Містить повідомлення про помилки
error.ettnID	string	Невірно вказаний eТТН

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

200 OK

Успішна відповідь: /domain/api/v1/ettn/{ettnID}/refdoc

[
    {
        "document": {
            "mimeType": "application/pdf",
            "size": 32321,
            "url": "https://shared.storage.tis.ioio/QWERTY",
            "signature": "NmMxYzUyZjA1YzQzMWFkY2YxYzkyMGE2NGVhYTRiZTgxZTYxYmFlYTM3OWYzNjllZWFmMGRmMzM0YzA0MTNiZiAgLQo=",
            "version": "string",
            "origin": "string"
        },
        "type": {
            "type": "ACT",
            "subtype": {
                "dict": "01.09",
                "value": "1"
            }
        },
        "signedBy": {
            "edrpou": "3058219188",
            "role": "CONSIGNOR",
            "representative": [
                {
                    "name": "string",
                    "role": "1",
                    "identification": [
                        {
                            "type": "PASSPORT",
                            "series": "string",
                            "seriesNo": "string",
                            "expires": "string"
                        }
                    ],
                    "signatureRequired": true
                }
            ]
        },
        "actors": [
            {
                "edrpou": "3058219188",
                "role": "CONSIGNOR",
                "representative": [
                    {
                        "name": "string",
                        "role": "1",
                        "identification": [
                            {
                                "type": "PASSPORT",
                                "series": "string",
                                "seriesNo": "string",
                                "expires": "string"
                            }
                        ],
                        "signatureRequired": true
                    }
                ]
            }
        ]
    }
]

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

В запиті невірно вказаний eТТН

422 Unprocessable Entity (WebDAV) (RFC 4918)

Неуспішна відповідь: /domain/api/v1/ettn/{ettnID}/refdoc

{
  "error": 
  [
    {"ettnID": "Не верно указан Еттн"},
  ]
}

Зареєструвати супровідну документацію по еТТН

Для реєстрації супровідної документації по еТТН виконується метод /domain/api/v1/ettn/{ettnID}/refdoc.

Запит виконується методом POST.

URI: /domain/api/v1/ettn/{ettnID}/refdoc

Параметри URI

Метод дозволяє передати ідентифікатор eТТН, у вигляді:

/domain/api/v1/ettn/{ettnID}/refdoc, де {ettnID} — ID eТТН отриманий запитом /domain/api/v1/ettn/.

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

Ім'я	Тип	Обов'язковий	Опис
ettnID	string	Так	ID eТТН отриманий запитом /domain/api/v1/ettn/

Приклад запиту

Запит: /domain/api/v1/ettn/{ettnID}/refdoc

{
    Xml eТТН
}

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

Ім'я	Тип	Опис
id	string	Ідентифікатор супровідної документації
entityId	string	Ідентифікатор супровідної документації в організації
error	list[object]	Містить повідомлення про помилки
error.ettnID	string	eТТН з таким ідентифікатором не знайдено

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

200 OK

Відповідь: /domain/api/v1/ettn/{ettnID}/refdoc

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

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

еТТН з таким ідентифікатором не знайдено

422 Unprocessable Entity (WebDAV) (RFC 4918)

Неуспішна відповідь: /domain/api/v1/ettn/{ettnID}/refdoc

{
  "error": 
  [
    {
      "ettnID": "еТТН з таким ідентифікатором не знайдено"
    },
  ]
}

Відміна документу з пакету супровідної документації

Для відміни документу з пакету супровідної документації виконується метод /domain/api/v1/ettn/refdoc/{id}.

Запит виконується методом PATCH.

URI: /domain/api/v1/ettn/refdoc/{id}

Параметри URI

Метод дозволяє передати ідентифікатор супровідної документації, у вигляді:

/domain/api/v1/ettn/refdoc/{id}, де {id} — ідентифікатор супровідної документації отриманий запитом /domain/api/v1/ettn/{ettnID}/refdoc.

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

Ім'я	Тип	Обов'язковий	Опис
id	string	Так	ID супровідної документації отриманий запитом /domain/api/v1/ettn/{ettnID}/refdoc

Приклад запиту

/domain/api/v1/ettn/645b50f79d81428162007a02/3fa85f64-5717-4562-b3fc-2c963f66afa6

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

Ім'я	Тип	Опис
message	string	Містить повідомлення з результатом виконання запиту
error	list[object]	Містить повідомлення про помилки
error.ettnID	string	eТТН з таким ідентифікатором не знайдено

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

200 OK

Відповідь: /domain/api/v1/ettn/refdoc/{id}

{
    "message": "Ok",
}

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

еТТН з таким ідентифікатором не знайдено

422 Unprocessable Entity (WebDAV) (RFC 4918)

Відповідь: /domain/api/v1/ettn/refdoc/{id}

{
  "error": 
  [
    {"ettnID": "еТТН з таким ідентифікатором не знайдено"},
  ]
}

Отримання документа з пакету супровідної документації

Для отримання документу з пакету супровідної документації виконується метод /domain/api/v1/ettn/refdoc/{id}.

Запит виконується методом GET.

URI: /domain/api/v1/ettn/refdoc/{id}

Параметри URI

Метод дозволяє передати ідентифікатор супровідної документації, у вигляді:

/domain/api/v1/ettn/refdoc/{id}, де {id} — ID супровідної документації отриманий запитом /domain/api/v1/ettn/{ettnID}/refdoc.

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

Ім'я	Тип	Обов'язковий	Опис
id	string	Так	ID супровідної документації отриманий запитом /domain/api/v1/ettn/{ettnID}/refdoc

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

Ім'я	Тип	Опис
document	object	Містить параметри супровідної документації по eТТН
document.mimeType	string	MIME Тип документа
document.size	integer	Розмір документа
document.url	string	Посилання на документ
document.signature	string	Підпис документа
document.version	string	Версія документа
document.origin	string	Походження документа
type	object	Містить параметри типа документа
type.type	string	Тип документа
type.subtype	object
type.subtype.dict	string
type.subtype.value	string
signedBy	object	Параметри підписанта документа
signedBy.edrpou	string	ЄДРПОУ підписанта
signedBy.role	string	Роль підписанта
signedBy.representative	list[object]	Загальні параметри підписанта
signedBy.representative.name	string	Ім'я підписанта документа
signedBy.representative.role	string	Роль підписанта документа
signedBy.representative.identification	list[object]	Містить параметри документа підтверджуючого особу підписанта документа
signedBy.representative.identification.type	string	Тип документа підтверджуючого особу підписанта документа
signedBy.representative.identification.series	string	Серія документа підтверджуючого особу підписанта документа
signedBy.representative.identification.seriesNo	string	Номер документа підтверджуючого особу підписанта документа
signedBy.representative.identification.expires	string	Строк дії документа підтверджуючого особу підписанта документа
signedBy.representative.signatureRequired	boolean	Вказується чи підпис підписанта обов'язковий
actors	list[object]	Параметри дійової особи
actors.edrpou	string	ЄДРПОУ дійової особи
actors.role	string	Роль дійової особи
actors.representative	list[object]	Загальні параметри дійової особи
actors.representative.name	string	Ім'я дійової особи
actors.representative.role	string	Роль дійової особи
actors.representative.identification	list[object]	Містить параметри документа підтверджуючого особу
actors.representative.identification.type	string	Тип документа підтверджуючого особу
actors.representative.identification.series	string	Серія документа підтверджуючого особу
actors.representative.identification.seriesNo	string	Номер документа підтверджуючого особу
actors.representative.identification.expires	string	Строк дії документа підтверджуючого особу
actors.representative.signatureRequired	boolean	Вказується чи підпис дійової особи обов'язковий
id	string	ID супровідної документації
status	string	Статус супровідної документації
ticket	string
error	list[object]	Містить повідомлення про помилки
error.ettnID	string	Невірно вказаний eТТН

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

200 OK

Відповідь: /domain/api/v1/ettn/refdoc/{id}

{
    "document": {
        "mimeType": "application/pdf",
        "size": 32321,
        "url": "https://shared.storage.tis.ioio/QWERTY",
        "signature": "NmMxYzUyZjA1YzQzMWFkY2YxYzkyMGE2NGVhYTRiZTgxZTYxYmFlYTM3OWYzNjllZWFmMGRmMzM0YzA0MTNiZiAgLQo=",
        "version": "string",
        "origin": "string"
    },
    "type": {
        "type": "ACT",
        "subtype": {
            "dict": "01.09",
            "value": "1"
        }
    },
    "signedBy": {
        "edrpou": "3058219188",
        "role": "CONSIGNOR",
        "representative": [
            {
                "name": "string",
                "role": "1",
                "identification": [
                    {
                        "type": "PASSPORT",
                        "series": "string",
                        "seriesNo": "string",
                        "expires": "string"
                    }
                ],
                "signatureRequired": true
            }
        ]
    },
    "actors": [
        {
            "edrpou": "3058219188",
            "role": "CONSIGNOR",
            "representative": [
                {
                    "name": "string",
                    "role": "1",
                    "identification": [
                        {
                            "type": "PASSPORT",
                            "series": "string",
                            "seriesNo": "string",
                            "expires": "string"
                        }
                    ],
                    "signatureRequired": true
                }
            ]
        }
    ],
    "id": "1d9097b8-f5a3-11e9-8cae-cf07ceac96a6",
    "status": "PENDING_SIGNATURE",
    "ticket": "string"
}

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

еТТН з таким ідентифікатором не знайдено

422 Unprocessable Entity (WebDAV) (RFC 4918)

Неуспішна відповідь: /domain/api/v1/ettn/refdoc/{id}

{
  "error": 
  [
    {"ettnID": "еТТН з таким ідентифікатором не знайдено"},
  ]
}

Зареєструвати наступну підписану версію документа

Для реєстрації наступної підписаної версії документа виконується метод /domain/api/v1/ettn/refdoc/{id}.

Запит виконується методом POST.

URI: /domain/api/v1/ettn/refdoc/{id}

Параметри URI

Метод дозволяє передати ідентифікатор супровідної документації, у вигляді:

/domain/api/v1/ettn/refdoc/{id}, де {id} — ідентифікатор супровідної документації отриманий запитом /domain/api/v1/ettn/{ettnID}/refdoc.

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

Ім'я	Тип	Обов'язковий	Опис
id	string	Так	ID супровідної документації отриманий запитом /domain/api/v1/ettn/{ettnID}/refdoc

Приклад запиту

Запит: /domain/api/v1/ettn/refdoc/{id}

<UAECMR>
  <eCMR>
    <SpecifiedSupplyChainConsignment>
      <ram:PreviousAdministrativeReferencedDocument>
        <ram:TypeCode>730</ram:TypeCode>
        <!-- Відповідає ExchangedDocumentContext.SpecifiedTransactionID попередніх версій-->
        <ram:ID>1</ram:ID>
        <ram:Remarks>
        <!-- Base64 документу версії 1 -->
        </ram:Remarks>
        <ram:AttachedSpecifiedBinaryFile>
        <!-- document.id із ЦБД еТТН -->
        <ram:ID>607cef34-5d8b-11ec-8f8b-c36339da6e6a</ram:ID>
        <!-- document.url із ЦБД еТТН, лінк на обʼєкт у провайдера -->
        <ram:URIID>http://shared.provider.url/607cef34-5d8b-11ec-8f8b-c36339da6e6a</ram:URIID>
        <ram:MIMECode>application/xml</ram:MIMECode>
        <!-- Розмір файлу, байт-->
        <ram:SizeMeasure>2048</ram:SizeMeasure>
        </ram:AttachedSpecifiedBinaryFile>
      </ram:PreviousAdministrativeReferencedDocument>
    </SpecifiedSupplyChainConsignment>
  </eCMR>
  <UaSignatureStorage>
    <VisualReferencedDocument>
      <ram:TypeCode>730</ram:TypeCode>
      <ram:Remarks><!--base64 графічного відображеня документу--></ram:Remarks>
    </VisualReferencedDocument>
    <Signature>
      <SigningPartyRoleCode>CN</SigningPartyRoleCode>
      <PartySignature><!-- base64 підпису p7s--></PartySignature>
      <Name>Петренко В.В.</Name>
      <Position>комірник</Position>
      <SpecifiedTaxRegistration>
        <ram:ID>12345678</ram:ID>
      </SpecifiedTaxRegistration>
    </Signature>
    <Signature>
      <SigningPartyRoleCode>CA</SigningPartyRoleCode>
      <PartySignature><!-- base64 підпису p7s--></PartySignature>
      <Name>Іваненко В.В.</Name>
      <Position>водій</Position>
      <SpecifiedTaxRegistration>
        <ram:ID>12345678</ram:ID>
      </SpecifiedTaxRegistration>
    </Signature>
  </UaSignatureStorage>
</UAECMR>

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

Ім'я	Тип	Опис
error	list[object]	Містить повідомлення про помилки
error.ettnID	string	eТТН з таким ідентифікатором не знайдено

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

У відповідь на запит ви отримаєте код 200 ОК.

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

еТТН з таким ідентифікатором не знайдено

422 Unprocessable Entity (WebDAV) (RFC 4918)

Відповідь: /domain/api/v1/ettn/refdoc/{id}

{
  "error": 
  [
    {"ettnID": "еТТН з таким ідентифікатором не знайдено"},
  ]
}

Додавання водія

Для додавання водія виконується метод /domain/api/v1/xml/ettn/users/store.

Запит виконується методом POST.

URI: /domain/api/v1/xml/ettn/users/store

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

Ім'я	Тип	Обов'язковий	Опис
id	string	Так

Приклад запиту

Запит: /domain/api/v1/xml/ettn/users/store

<UAECMR>
  <eCMR>
    <SpecifiedSupplyChainConsignment>
      <ram:CarrierTradeParty>
        <ram:DefinedTradeContact>
          <ram:PersonName>Васильченко Василь Васильович</ram:PersonName>
            <ram:TelephoneUniversalCommunication>
              <ram:CompleteNumber>0441112233</ram:CompleteNumber>
            </ram:TelephoneUniversalCommunication>
            <ram:MobileTelephoneUniversalCommunication>
              <ram:CompleteNumber>0931112233</ram:CompleteNumber>
            </ram:MobileTelephoneUniversalCommunication>
            <ram:EmailURIUniversalCommunication>
              <ram:CompleteNumber>[email protected]</ram:CompleteNumber>
            </ram:EmailURIUniversalCommunication>
        </ram:DefinedTradeContact>
      </ram:CarrierTradeParty>
    </SpecifiedSupplyChainConsignment>
  </eCMR>
<UAECMR>

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

Ім'я	Тип	Опис
id	string	Ідентифікатор водія
error	list[object]	Містить повідомлення про помилки

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

200 OK

Відповідь: /domain/api/v1/xml/ettn/users/store

{
  "id": "12345678",
}

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

Невірний формат електронної пошти

422 Unprocessable Entity (WebDAV) (RFC 4918)

Відповідь: /domain/api/v1/xml/ettn/users/store

{
  "error": 
  [
    {
      "EmailURIUniversalCommunication": "Невірний формат електронної пошти"
    },
  ]
}

Перегляд даних водія taskId

Для перегляду даних водія taskId виконується метод /domain/api/v1/xml/ettn/users/{id}.

Запит виконується методом ПУЕ.

URI: /domain/api/v1/xml/ettn/users/{id}

Параметри URI

Метод дозволяє передати ідентифікатор водія, у вигляді:

/domain/api/v1/xml/ettn/users/{id}, де {id} — ідентифікатор водія отриманий запитом /domain/api/v1/xml/ettn/users/store.

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

Ім'я	Тип	Обов'язковий	Опис
id	string	Так	Ідентифікатор водія отриманий запитом /domain/api/v1/xml/ettn/users/store

Приклад запиту

Запит: /domain/api/v1/xml/ettn/users/{id}

<UAECMR>
  <eCMR>
    <SpecifiedSupplyChainConsignment>
      <ram:CarrierTradeParty>
        <ram:DefinedTradeContact>
          <ram:PersonName>Васильченко Василь Васильович</ram:PersonName>
          <ram:TelephoneUniversalCommunication>
            <ram:CompleteNumber>0441112233</ram:CompleteNumber>
          </ram:TelephoneUniversalCommunication>
          <ram:MobileTelephoneUniversalCommunication>
            <ram:CompleteNumber>0931112233</ram:CompleteNumber>
          </ram:MobileTelephoneUniversalCommunication>
          <ram:EmailURIUniversalCommunication>
            <ram:CompleteNumber>[email protected]</ram:CompleteNumber>
          </ram:EmailURIUniversalCommunication>
        </ram:DefinedTradeContact>
      </ram:CarrierTradeParty>
    </SpecifiedSupplyChainConsignment>
  </eCMR>
<UAECMR>

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

Ім'я	Тип	Опис
id	integer	Ідентифікатор водія
name	string	Ім'я водія
email	string	Електронна пошта водія
email_verified_at	string	Дата підтвердження електронної пошти
created_at	string	Дата створення водія
updated_at	string	Дата останнього оновлення даних водія
surname	string	Прізвище водія
patronymic	string	По батькові водія
telephone	string	Номер стаціонарного телефона водія
mobile	string	Номер мобільного телефона водія
postCode	string	Поштовий індекс
street	string	Адреса проживання водія
city	string	Назва міста
countryID	string	Ідентифікатор країни
countryName	string	Назва країни
taxRegistration	string
code	string
error	list[object]	Містить повідомлення про помилки

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

200 OK

Відповідь: /domain/api/v1/xml/ettn/users/{id}

{
  "id": 268,
  "name": "Василь",
  "email": "[email protected]",
  "email_verified_at": null,
  "created_at": null,
  "updated_at": null,
  "surname": "Васильченко",
  "patronymic": "Васильович",
  "telephone": "0441112233",
  "mobile": "0931112233",
  "postCode": "01001",
  "street": "вул.Хрещатик, 22",
  "city": "Київ",
  "countryID": "UA",
  "countryName": "м.Київ",
  "taxRegistration": "12345678",
  "code": null
}

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

Невірний формат електронної пошти

422 Unprocessable Entity (WebDAV) (RFC 4918)

Відповідь: /domain/api/v1/xml/ettn/users/{id}

{
  "error": 
  [
    {
      "EmailURIUniversalCommunication": "Невірний формат електронної пошти"
    },
  ]
}

Список водіїв

Для перегляду списку водіїв виконується метод /domain/api/v1/xml/ettn/users/drivers.

Запит виконується методом ПУЕ.

URI: /domain/api/v1/xml/ettn/users/drivers

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

Ім'я	Тип	Обов'язковий	Опис
id	string	Так

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

Ім'я	Тип	Опис
id	integer	Ідентифікатор водія
name	string	Ім'я водія
email	string	Електронна пошта водія
email_verified_at	string	Дата підтвердження електронної пошти
created_at	string	Дата створення водія
updated_at	string	Дата останнього оновлення даних водія
surname	string	Прізвище водія
patronymic	string	По батькові водія
telephone	string	Номер стаціонарного телефона водія
mobile	string	Номер мобільного телефона водія
postCode	string	Поштовий індекс
street	string	Адреса проживання водія
city	string	Назва міста
countryID	string	Ідентифікатор країни
countryName	string	Назва країни
taxRegistration	string
code	string
error	list[object]	Містить повідомлення про помилки

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

200 OK

Відповідь: /domain/api/v1/xml/ettn/users/drivers

{
  "id": 268,
  "name": "Василь",
  "email": "[email protected]",
  "email_verified_at": null,
  "created_at": null,
  "updated_at": null,
  "surname": "Васильченко",
  "patronymic": "Васильович",
  "telephone": "0441112233",
  "mobile": "0931112233",
  "postCode": "01001",
  "street": "вул.Хрещатик, 22",
  "city": "Київ",
  "countryID": "UA",
  "countryName": "м.Київ",
  "taxRegistration": "12345678",
  "code": null
}

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

Невірний формат електронної пошти

422 Unprocessable Entity (WebDAV) (RFC 4918)

Відповідь: /domain/api/v1/xml/ettn/users/drivers

{
  "error": 
  [
    {
      "EmailURIUniversalCommunication": "Невірний формат електронної пошти"
    },
  ]
}

Оновлення даних водія

Для оновлення даних водія виконується метод /domain/api/v1/xml/ettn/users/{id}.

Запит виконується методом PUT.

URI: /domain/api/v1/xml/ettn/users/{id}

Параметри URI

Метод дозволяє передати ідентифікатор водія, у вигляді:

/domain/api/v1/xml/ettn/users/{id}, де {id} — ідентифікатор водія отриманий запитом /domain/api/v1/xml/ettn/users/store.

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

Ім'я	Тип	Обов'язковий	Опис
id	string	Так	Ідентифікатор водія отриманий запитом /domain/api/v1/xml/ettn/users/store

Приклад запиту

Запит: /domain/api/v1/xml/ettn/users/{id}

<UAECMR>
  <eCMR>
    <SpecifiedSupplyChainConsignment>
      <ram:CarrierTradeParty>
        <ram:DefinedTradeContact>
          <ram:PersonName>Васильченко Василь Васильович</ram:PersonName>
          <ram:TelephoneUniversalCommunication>
            <ram:CompleteNumber>0441112233</ram:CompleteNumber>
          </ram:TelephoneUniversalCommunication>
          <ram:MobileTelephoneUniversalCommunication>
            <ram:CompleteNumber>0931112233</ram:CompleteNumber>
          </ram:MobileTelephoneUniversalCommunication>
          <ram:EmailURIUniversalCommunication>
            <ram:CompleteNumber>[email protected]</ram:CompleteNumber>
          </ram:EmailURIUniversalCommunication>
        </ram:DefinedTradeContact>
      </ram:CarrierTradeParty>
    </SpecifiedSupplyChainConsignment>
  </eCMR>
<UAECMR>

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

Ім'я	Тип	Опис
id	string
error	list[object]	Містить повідомлення про помилки

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

200 OK

Відповідь: /domain/api/v1/xml/ettn/users/{id}

{
  "id": "12345678", 
}

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

Невірний формат електронної пошти

422 Unprocessable Entity (WebDAV) (RFC 4918)

Відповідь: /domain/api/v1/xml/ettn/users/{id}

{
  "error": 
  [
    {
      "EmailURIUniversalCommunication": "Невірний формат електронної пошти"
    },
  ]
}

Видалення водія

Для видалення водія виконується метод /domain/api/v1/xml/ettn/users/{id}/drivers.

Запит виконується методом DELETE.

URI: /domain/api/v1/xml/ettn/users/{id}/drivers

Параметри URI

Метод дозволяє передати ідентифікатор водія, у вигляді:

/domain/api/v1/xml/ettn/users/{id}/drivers, де {id} — ідентифікатор водія отриманий запитом /domain/api/v1/xml/ettn/users/store.

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

Ім'я	Тип	Обов'язковий	Опис
id	string	Так	Ідентифікатор водія отриманий запитом /domain/api/v1/xml/ettn/users/store

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

Ім'я	Тип	Опис
message	string	Містить повідомлення з результатом виконання запиту
error	list[object]	Містить повідомлення про помилки
error.id	string	Водій з таким id відсутній

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

200 OK

Відповідь: /domain/api/v1/xml/ettn/users/{id}/drivers

{
  "message": "Ok", 
}

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

Водій з таким id відсутній

422 Unprocessable Entity (WebDAV) (RFC 4918)

Відповідь: /domain/api/v1/xml/ettn/users/{id}/drivers

{
  "error": 
  [
    {
      "id": "Водій з таким id відсутній"
    },
  ]
}