Отримання ланцюжка документів сервісу «ЕТТН» по id ланцюжка чи id документа

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту	HTTP GET
Content-Type	application/json (тіло запиту/відповіді в json форматі)
URL запиту	{url серверу} /api/ettn/eds/chain
Параметри, що передаються в URL (разом з адресою методу)	В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: company_uuid - ідентифікатор компанії chain_uuid або doc_uuid - ідентифікатор ланцюжка або ідентифікатор документа відповідно

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

У відповідь передаються дані ланцюжка документів (об’єкт XChain).

Таблиця 1 - Опис параметрів об’єкта XChain

Параметр	Формат	Опис
	Об’єкт XChain
id	long	ID шарда
uuid	UUID	UUID ланцюжка документів
packageID	long	ID пакета
type	XDocType_	об’єкт; тип документа
docsCount	int	кількість документів в ланцюжку
lastInDocID	long	id останнього вхідного документа в ланцюжку
lastOutDocID	long	id останнього вихідного документа в ланцюжку
partnerId	long	id роздрібної мережі
important	boolean	відмітка важливий документ
status	XChainStatus	об’єкт; статус пари документів у відправника і одержувача
visualStatus	int	номер іконки
archive	boolean	відмітка; Архівний документ чи ні
childs	List< XDoc >	масив об’єктів; дані документів/квитанцій
chainsInPackage	List<XChain>	масив об’єктів; дані пов’язаних ланцюжків
hash	String	хеш-значення, отримане в результаті обробки

Таблиця 2 - Опис параметрів об’єкта XChainStatus

Параметр	Формат	Опис
	Об’єкт XChainStatus
state	int	id статусу
title	String	статус

Таблиця 3 - Опис параметрів об’єкта XDoc

Параметр	Формат	Опис
	Об’єкт XDoc
body	XDocBodyForms_	об’єкт; тіла документів
attachments	List<XDocAttachment_>	масив об’єктів; вкладення (може не використовуватися)
comments	XDocCommentsList_	об’єкт (в якому масив об’єктів); список коментарів
doc_id	long	id документа
doc_uuid	UUID	унікальний ідентифікатор документа/квитанції
uuidSender	String	унікальний ідентифікатор відправника
uuidReceiver	String	унікальний ідентифікатор одержувача
docNumber	String	номер документа
dateCreated	long	дата створення документа (unix timestamp)
dateChanged	long	дата останньої зміни документа (unix timestamp)
dateRead	long	дата прочитання документа (unix timestamp)
docDate	long	дата документа, зазначена в документі
chain_id	long	id ланцюжка документів
chain_uuid	UUID	унікальний ідентифікатор ланцюжка документів
family	int	сімейство (EDI / UZD)
hash	String	хеш-значення, отримане в результаті обробки
type	XDocType_	об’єкт; тип документа
status	XDocStatus_	об’єкт; статус пари документів у відправника і одержувача
exchange_status	String	сабстатус документа
is_archive	boolean	відмітка; Архівний документ чи ні
signInfo	XDocSignInfo_	об’єкт; дані про підписи
chain	XChain	объект; дані пов’язаних ланцюжків
extraFields	Map<String, String>	масив об’єктів; набір індексів (аналог індексних таблиць)
tags	List<XTag_>	масив об’єктів; прикріплені теги
statuses	List<XStatus_>	масив об’єктів; статуси обробки відправлених документів
multiExtraFields	Map<String, List<String>>	масив об’єктів; мультиіндекс. Приклад: {„key1“: [„val1“, „val2“], „key2“: [„val1“, „val2“]}. Використовується, наприклад для обробки передаваємого рядка => розбивка рядка за умовою => індексування кожного шматка

---

Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)

---

Приклад тіла відповіді в json форматі:

{
  приклад тимчасово відсутній
}