API «ETTN» v3¶

Алгоритми обміну документами (API)¶

Підказка

Всі запити нижче перерахованих API методів сервісу «ЕТТН» направляються на адресу: https://edo-v2.edin.ua

Авторизація¶

Метод	URL запиту	Опис
POST	`/api/authorization/hash`	Авторизація
GET	`/api/auth_check`	Перевірка активності сесії

Загальні методи сервісу «ЕТТН»¶

Метод	URL запиту	Опис
GET	`/api/eds/doc/ettn/body`	Отримання (завантаження) тіла документа сервісу «ЕТТН» в JSON/XML/ECMR/PDF/ZIP форматі
POST	`/api/eds/doc/ettn/sign`	Підписання даних сервісу «ЕТТН» (збереження підпису)
GET	`/api/eds/doc/tickets`	Отримання всіх квитанцій вказаного документа
GET	`/api/eds/doc`	Отримання інформації (мета-даних) про документ
GET	`/api/eds/doc/ettn/sign/info`	Отримання інформації про підписантів е-ТТН та Актів v3 (family=7)
PATCH	`/api/eds/docs`	Видалити документи-чернетки

Робота з «Електронною товарно-транспортною накладною» (е-ТТН)¶

Метод	URL запиту	Опис
POST	`/api/eds/doc/ettn/ttn`	Створення/редагування чернетки «Електронної товарно-транспортної накладної» (е-ТТН)
PATCH	`/api/eds/doc/ettn/ttn/send`	Відправка електронної товарно-транспортної накладної («е-ТТН») з Чернеток
POST	`/api/eds/doc/ettn/ttn/transaction`	Створення/редагування нової транзакції (чернетки) до е-ТТН документа
PUT	`/api/eds/doc/ettn/ttn/transaction`	Відправка нової транзакції до е-ТТН документа
PUT	`/api/eds/doc/ettn/ttn/reject`	Відхилення «Електронної товарно-транспортної накладної» (е-ТТН)
POST	`/api/eds/doc/ettn/ttn/attachment`	Додавання до документа вкладення (pdf) до документа е-ТТН
GET	`/api/eds/doc/ettn/ttn/attachment`	Отримання (завантаження) файлу-вкладення до документа е-ТТН
PATCH	`/api/eds/doc/ettn/ttn/attachment`	Відправки вкладення на повторну реєстрацію (при виникненні помилки)
DELETE	`/api/eds/doc/ettn/ttn/attachment`	Видалення файлу-вкладення до документа е-ТТН

Робота з актами («Акт перевантаження», «Акт коригування», …) до е-ТТН¶

Метод	URL запиту	Опис
POST	`/api/eds/doc/ettn/adjustment`	Створення/редагування чернетки «Акта коригування» до е-ТТН
POST	`/api/eds/doc/ettn/consignee_change`	Створення/редагування чернетки «Акта про заміну пункту призначення вантажу» до е-ТТН
POST	`/api/eds/doc/ettn/disagreement`	Створення/редагування чернетки «Акта розбіжностей про вантаж» до е-ТТН
POST	`/api/eds/doc/ettn/load_reject`	Створення/редагування чернетки «Акта про відмову вантажити» до е-ТТН
POST	`/api/eds/doc/ettn/reload`	Створення/редагування чернетки «Акта перевантаження» до е-ТТН
POST	`/api/eds/doc/ettn/resealing`	Створення/редагування чернетки «Акта перепломбування» до е-ТТН
POST	`/api/eds/doc/ettn/stop`	Створення/редагування чернетки «Акта примусового завершення е-ТТН»
POST	`/api/eds/doc/ettn/storage_delivery`	Створення/редагування чернетки «Акта розвантаження на проміжному складі» до е-ТТН
POST	`/api/eds/doc/ettn/storage_pickup`	Створення/редагування чернетки «Акта завантаження на проміжному складі» до е-ТТН

Метод	URL запиту	Опис
POST	`/api/eds/doc/ettn/act/transaction`	Створення/редагування нової транзакції (чернетки) до Актів сервісу
PUT	`/api/eds/doc/ettn/act/transaction`	Відправка нової транзакції до Актів сервісу
PUT	`/api/eds/doc/ettn/act/reject`	Відхилення Актів сервісу
PATCH	`/api/eds/doc/ettn/act/send`	Відправка Актів з Чернеток

Підписки на події¶

Метод	URL запиту	Опис
GET	`/api/mintrans/subscribe`	Отримання даних про підписки на події (отримання документів)
POST	`/api/mintrans/subscribe`	Створення (оформлення) підписки на події (отримання документів)
DELETE	`/api/mintrans/subscribe`	Видалення підписки на події (отримання документів)
GET	`/api/mintrans/events`	Отримання списку подій з ЦБД
GET	`/api/mintrans/doc`	Отримання документа з ЦБД

Опис помилок сервісу «ЕТТН» v3¶

Запит	Код відповіді	Текст помилки	Опис
POST, «/api/eds/doc/ettn/ttn»	400	Setup content type in request. Use „application/json“ or „application/xml“	В запиті не вказано заголовок content-type
		Unsupported content type. Use „application/xml“ or „application/json“	Вказано некорректний content-type
		Setup document number[ecmr.exchangedDocument.id]	в документі не заповнено вказане в тексті помилки поле
		Setup document date[ecmr.exchangedDocument.issueDateTime.dateTime]	в документі не заповнено вказане в тексті помилки поле
		Setup document date[ecmr.exchangedDocument.issueDateTime.dateTime]	в документі не заповнено вказане в тексті помилки поле
		edrpou is not filled in gln %s	У вказанному gln не заповнено ЄДРПОУ
		trade party for gln %s not found in the document	учасника документа для gln не знайдено (некоректно заповнено документ)
		edrpou %s from gln %s and document %s are different	ЄДРПОУ в gln і з документа не збігаються
	400	driverLicense is not fill in gln %s	не заповнено водійське посвідчення в gln
	400	ipn is not fill in gln %s	не заповнено інн в gln
	400	field [carrier.specifiedGovernmentRegistration.id] is not filled	в документі не заповнено вказане в тексті помилки поле
	400	driverLicense %s from driver gln and document %s must be equals	водійське посвідчення в gln і з документа не збігаються
	400	field [carrier.taxRegistration.id] is not filled	в документі не заповнено вказане в тексті помилки поле
	400	inn %s from driver gln and document %s must be equals	інн в gln і з документа не збігаються
	400	gln for %s not found	Gln для адреси навантаження/розвантаження не знайдено
	400	«gln for %s does not contain katottg	в gln не заповнено КАТОТТГ
	400	katottg for %s is required	не заповнено КАТОТТГ для пункту розвантаження/навантаження
	400	katottg from document %s and gln %s are different	КАТОТТГ в gln і з документа не збігаються
	400	«address in gln %s %s not equal address in document %s	адреса в gln і з документа не збігаються
		Unknown consignor [%s]	не знайдено consignor
		Unknown carrier [%s]	не знайдено carrier
		Unknown customer [%s]	не знайдено customer
GET, «/api/eds/doc/ettn/body»		«body not found or not created yet»	тіло документа не знайдено або ще не створено
		Unsupported format	url параметр format містить некорректне значення. Очікується (xml \| ecmr \|json\|pdf\|zip)
		body not found or not created yet	тіло документа не знайдено або ще не створено
		Unknown „response_type“:	response_type url param (xml \| ecmr \|json\|pdf\|zip)
GET, «/api/eds/doc/ettn/sign/info»		Unknown or unsupported doc type
PUT, «/api/eds/doc/ettn/ttn/reject»		Param „rejected_by“ required
		action not available for open documents
		Only consignor, customer, carrier, driver or consignee can reject document
		Detect sub status error. Current = %s
POST, «/api/eds/doc/ettn/sign»		[role_code] required
		Unknown or unsupported role_code
		sign is empty
		content for sign is not created
		Indicated in URL-parameter company role does not match the role of this company in the document structure
		sign_hash is broken, re-save document
		Work with TTN is temporarily unavailable. Due to the unfinished process of working with the act [name of the act] to this TTN. Wait for the completion of work on it.	Робота з ТТН тимчасово недоступна. У зв’язку з незавершеним процесом роботи з актом [назва акта] до даної ТТН. Дочекайтеся завершення роботи над ним.
PATCH, «/api/eds/doc/ettn/ttn/send»		Document must be OPEN status
		Direction error	не відповідність ролі учасника
		Sender not equals consignor
		Work with TTN is temporarily unavailable. Due to the unfinished process of working with the act [name of the act] to this TTN. Wait for the completion of work on it.	Робота з ТТН тимчасово недоступна. У зв’язку з незавершеним процесом роботи з актом [назва акта] до даної ТТН. Дочекайтеся завершення роботи над ним.
post, /api/eds/doc/ettn/ttn/attachment		Setup „type“ param	get attachment type
		«incorrect type: %s one of: “»1», «2», «3», «4», «5», «6», «7», «8», «9», «10», «11», «12», «13», «14», «15», «16», «17», «18», «19», «20», «21», «22», «23», «24», «25» “ expected	некоректний url параметр type
		expected 1 file in multipart/form data	в запиті повинен бути лише 1 файл
		Unsupported file type %s	некоректний тип файлу, підтримується лише application/pdf
get, /api/eds/doc/ettn/ttn/attachment		Unknown type: %s	некоректний url параметр type очікується (file \|bytes \| list)
		attach_uuid“ param required
		Attachment not found
delete, /api/eds/doc/ettn/ttn/attachment		„attach_uuid“ param required
		attachment not found
Post /api/eds/doc/ettn/ttn/transaction		action not available for open documents
PUT /api/eds/doc/ettn/ttn/transaction		Unsupported substatus: %s	Некоректний substatus документа
registrationErrors:		incorrect doc status
		direction error	не відповідність ролі учасника
		xsd errors