Отримання конкретного ланцюжка документів
Для роботи з цим методом користувач повинен бути авторизованим .
За допомогою методу api/eds/chain і заданих параметрів можливо отримати (вивантажити) необхідні дані конкретного ланцюжка документів.
Метод запиту |
HTTP GET |
---|---|
Content-Type |
application/json (тіло HTTP запиту / відповіді в json форматі) |
URL запиту |
|
Параметри, що передаються в URL (разом з адресою методу) |
У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації Обов’язкові url-параметри: gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта chain_uuid - рядок; ID ланцюжка Опціональні url-параметри (boolean фільтри): load_docs - чи завантажувати документи, що відносяться до ланцюжка load_bodies - чи завантажувати тіла документів load_package - чи завантажувати пакети load_comments - чи завантажувати коментарі load_tags - чи завантажувати теги до документів load_statuses - чи завантажувати статуси до документів |
Підказка
Також можливо виконати запит у вигляді curl-рядка:
curl -X GET „https://edo-v2.edin.ua/api/eds/chain?gln=9864065702429&chain_uuid=9fe45d32-35c7-44d0-9131-7257fc0c0f39&load_docs=true&load_bodies=true&load_package=true&load_comments=true&load_tags=true&load_statuses=true“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“
Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html
JSON-параметри в тілі HTTP запиту/відповіді
REQUEST
У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).
RESPONSE
Таблиця 4 - Опис json-параметрів, які можуть передаватися у відповідь на метод API
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XChain |
||
id |
long |
ID ланцюжка |
uuid |
UUID |
UUID ланцюжка документів |
packageID |
long |
ID пакета |
type |
об’єкт; тип документа |
|
docsCount |
int |
кількість документів в ланцюжку |
lastInDocID |
long |
id останнього вхідного документа в ланцюжку |
lastOutDocID |
long |
id останнього вихідного документа в ланцюжку |
partnerId |
long |
id роздрібної мережі |
important |
boolean |
відмітка важливий документ |
status |
об’єкт; статус пари документів у відправника і одержувача |
|
visualStatus |
int |
номер іконки |
archive |
boolean |
відмітка; Архівний документ чи ні |
childs |
List<XDoc> |
масив об’єктів; дані документів/квитанцій |
chainsInPackage |
List<XChain> |
масив об’єктів; дані пов’язаних ланцюжків |
hash |
String |
хеш-значення, отримане в результаті обробки |
Таблиця 5 - Опис параметрів об’єкта XChainStatus)
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XChainStatus |
||
state |
int |
id статусу |
title |
String |
статус |
Таблиця 6 - Опис параметрів об’єкта XDocStatus)
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocStatus |
||
state |
int |
id статусу |
title |
String |
статус |
Таблиця 7 - Опис параметрів об’єкта XDoc)
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDoc |
||
body |
об’єкт; тіла документів |
|
attachments |
List<XDocAttachment_> |
масив об’єктів; вкладення (може не використовуватися) |
comments |
об’єкт (в якому масив об’єктів); список коментарів |
|
doc_id |
long |
id документа |
doc_uuid |
UUID |
унікальний ідентифікатор документа/квитанції |
uuidSender |
String |
унікальний ідентифікатор відправника |
uuidReceiver |
String |
унікальний ідентифікатор одержувача |
uuidReceivers |
List<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 |
сімейство
|
hash |
String |
хеш-значення, отримане в результаті обробки |
type |
об’єкт; тип документа |
|
status |
об’єкт; статус пари документів у відправника і одержувача |
|
exchange_status |
String |
сабстатус документа (детальніше) |
is_archive |
boolean |
відмітка; Архівний документ чи ні |
signInfo |
об’єкт; дані про підписи |
|
chain |
XChain |
об’єкт; дані пов’язаних ланцюжків |
extraFields |
Map<String, String> |
масив об’єктів; набір індексів (аналог індексних таблиць) |
tags |
List<XTag> |
масив об’єктів; прикріплені теги |
statuses |
List<XStatus> |
масив об’єктів; статуси обробки відправлених документів |
multiExtraFields |
Map<String, List<String>> |
масив об’єктів; мультиіндекс. Приклад: {„key1“: [„val1“, „val2“], „key2“: [„val1“, „val2“]}. Використовується, наприклад для обробки передаваємого рядка => розбивка рядка за умовою => індексування кожного шматка |
Таблиця 8 - Опис параметрів об’єкта XTag)
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XTag |
||
id |
long |
id тега |
name |
String |
зміст тега |
shortName |
String |
коротка назва тега |
Таблиця 9 - Опис параметрів об’єкта XStatus)
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XStatus |
||
docId |
long |
id документа/квитанції |
date |
long |
дата статусу; формат unix timestamp |
type |
int |
тип статусу
|
text |
String |
текстовий коментар |
Таблиця 10 - Опис параметрів об’єкта XDocSignInfo)
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocSignInfo |
||
doc_id |
long |
id документа/квитанції |
date |
long |
дата підписання; формат unix timestamp |
count |
short |
кількість підписів |
info |
String |
додаткова інформація |
hash |
String |
хеш-значення, отримане в результаті обробки |
Таблиця 11 - Опис параметрів об’єкта XDocCommentsList)
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocCommentsList |
||
XDocCommentsList |
List<XDocComment> |
масив об’єктів; коментарі до документа |
Таблиця 12 - Опис параметрів об’єкта XDocComment)
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocComment |
||
id |
long |
id коментаря |
docUUID |
UUID |
унікальний ідентифікатор документа |
createTimestamp |
long |
дата створення коментаря у форматі timestamp |
authorLogin |
String |
автор коментаря |
comment |
String |
зміст коментаря |
Таблиця 13 - Опис параметрів об’єкта XDocAttachment)
Таблиця 14 - Опис параметрів об’єкта XDocBodyForms)
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocBodyForms |
||
forms |
HashMap<String, XDocBody> |
масив об’єктів; тіло документа |
Таблиця 15 - Опис параметрів об’єкта XDocBody)
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocBody |
||
type |
об’єкт; тип тіла документа: CONTENT = 1 - зміст в байтах; JSON = 2 - зміст в json форматі; SIGN = 3 - зміст підпису; STAMP = 4; CRYPTED = 5 - зміст в зашифрованому вигляді; UZDRESPONSE = 6 |
|
base64content |
String |
зміст тіла документа в BASE64 |
Таблиця 16 - Опис параметрів об’єкта XDocBodyType)
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocBodyType |
||
id |
int |
id типу тіла документа |
name |
String |
назва типу тіла документа |
Таблиця 17 - Опис параметрів об’єкта XDocType)
Параметр |
Тип |
Формат |
Опис |
---|---|---|---|
Об’єкт XDocType |
|||
type |
int |
id типу документа/квитанції |
|
title |
String |
назва документа/квитанции |
|
description |
String |
опис документа/квитанції (найменування кирилицею) |
Таблиця 18 - Опис DocStatus параметрів (об’єкт XDocStatus)
id статусу |
статус |
---|---|
0 |
ALL - будь-який статус |
1 |
OPEN - чернетка (відправник) |
2 |
SENT - відправлений (відправник) |
3 |
DELIVERED - доставлений (відправник) |
4 |
INBOX - вхідний (одержувач) |
5 |
READ - прочитаний (одержувач) |
6 |
ERROR - помилка |
7 |
DELETED - видалений |
Таблиця 19 - Опис DocType параметрів (об’єкт XDocType)
Тип |
Назва (doc_type) |
Опис (найменування кирилицею) |
---|---|---|
0 |
all |
всі |
1 |
invoice |
|
2 |
orders |
|
3 |
recadv |
|
4 |
desadv |
|
5 |
ordrsp |
|
6 |
pricat |
|
7 |
comdis |
|
10 |
declar |
|
11 |
insdes |
|
13 |
slsrpt |
|
14 |
invrpt |
|
15 |
coacsu |
|
17 |
iftmin |
|
18 |
retann |
|
19 |
iftmbf |
|
20 |
partin |
|
21 |
mscons |
|
22 |
transportationorder |
Заявка на транспортування / Підтвердження заявки на транспортування |
25 |
retins |
|
28 |
comdoc |
|
29 |
declarj12 |
|
30 |
condra |
|
35 |
metro7a |
|
39 |
metro7b |
|
40 |
prodlist |
|
41 |
agreem |
|
42 |
iftmbc |
|
59 |
documentinvoice |
|
67 |
doccorinvoice |
|
72 |
metro7c |
|
98 |
quotes |
|
111 |
transhipment |
|
117 |
acceptance |
|
113 |
booking |
|
114 |
bookingconfirmation |
|
115 |
ordrpt |
|
112 |
completion |
|
118 |
docinvoiceact |
|
119 |
discrepancy |
|
120 |
contrl |
|
121 |
ttn |
|
122 |
simple_doc |
Документ сервісу «Вільний» |
123 |
reload |
|
124 |
disagreement |
|
125 |
adjustment |
|
126 |
warehouse_change |
|
127 |
unload_storage |
Акт розвантаження на проміжному складі |
128 |
load_storage |
Акт завантаження на проміжному складі |
129 |
ettn_stop |
Акт примусового завершення ТТН |
130 |
resealing |
Акт переопломбування |
131 |
load_reject |
Акт відмови завантаження |
132 |
ttn_ecmr |
ETTN (v3) |
133 |
reload_ecmr |
Акт перевантаження (v3) |
134 |
disagreement_ecmr |
Акт розбіжностей (v3) |
135 |
consignee_change_ecmr |
Акт зміни пункту призначення (v3) |
136 |
storage_delivery_ecmr |
Акт розвантаження на проміжному складі (v3) |
137 |
adjustment_ecmr |
Акт коригування (v3) |
138 |
storage_pickup_ecmr |
Акт завантаження на проміжному складі (v3) |
139 |
resealing_ecmr |
Акт перепломбування (v3) |
140 |
load_reject_ecmr |
Акт відмови завантаження (v3) |
141 |
stop_ecmr |
Акт примусового завершення е-ттн (v3) |
Приклади
При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)
Приклади url-запитів:
Отримати перелік документів за визначеним ланцюжком без завантаження їхніх тіл, пакетів, коментарів, тегів і статусів
Отримати перелік документів за визначеним ланцюжком з завантаженням тіл і коментарів без завантаження їхніх пакетів, тегів і статусів
Отримати перелік документів за визначеним ланцюжком з завантаженням пакетів, тегів без завантаження їхніх тіл і коментарів і статусів
Отримати перелік документів за визначеним ланцюжком з завантаженням статусів без завантаження їхніх тіл, коментарів, пакетів, тегів
Приклад тіла відповіді (json):
{
"id": 1,
"uuid": "0fe60377-51db-4b7a-b7eb-cdf5fa91a46a",
"packageID": 0,
"type": {
"type": 5,
"title": "ordrsp",
"description": "Подтверждение заказа"
},
"docsCount": 13,
"lastInDocID": 1,
"lastOutDocID": 29,
"partnerId": 0,
"important": false,
"status": {
"status": 2,
"title": "sent"
},
"visualStatus": 0,
"archive": false,
"childs": [
{
"body": {
"forms": {}
},
"attachments": [],
"comments": [],
"doc_id": 1,
"doc_uuid": "bf8dacb1-7b61-4c9c-ab36-ac37620db051",
"uuidSender": "9864232304319",
"uuidReceiver": "9864232304302",
"docNumber": "1001",
"dateCreated": 1555487166,
"dateChanged": 1555487166,
"dateRead": 1555497325,
"docDate": 1555448400,
"chain_id": 1,
"chain_uuid": "0fe60377-51db-4b7a-b7eb-cdf5fa91a46a",
"family": 1,
"hash": "A1FF5B519289B936A09E99514277F429",
"type": {
"type": 2,
"title": "orders",
"description": "Заказ"
},
"status": {
"status": 5,
"title": "read"
},
"exchange_status": "000000000000000000000000",
"is_archive": false,
"extraFields": {
"sub_doc_type_id": "2",
"buyer_uuid": "9864232304319",
"doc_num": "1001",
"order_number": "1001",
"ftpex_file_date": "1555487160",
"supplier_uuid": "9864232304302",
"delivery_place_uuid": "9864232304562",
"order_date": "1555448400",
"delivery_date": "1556485200",
"ftpex_file_name": "order_20190417104600_475593380.xml",
"contract_number": "Дог 1",
"sender": "9864232304319",
"doc_date": "1555448400",
"recipient": "9864232304302",
"action": "0"
},
"tags": [],
"statuses": [],
"multiExtraFields": {}
},
...
{
"body": {
"forms": {}
},
"attachments": [],
"comments": [],
"doc_id": 29,
"doc_uuid": "cb2f183f-ccbc-467b-9eb2-90b2c1ff8f5c",
"uuidSender": "9864232304302",
"uuidReceiver": "9864232304319",
"docNumber": "АФ00-000001",
"dateCreated": 1556115021,
"dateChanged": 1556115022,
"dateRead": 0,
"docDate": 1556116482,
"chain_id": 1,
"chain_uuid": "0fe60377-51db-4b7a-b7eb-cdf5fa91a46a",
"family": 1,
"hash": "0F9CEEC0717992EB76A848F2E106D2D0",
"type": {
"type": 5,
"title": "ordrsp",
"description": "Подтверждение заказа"
},
"status": {
"status": 2,
"title": "sent"
},
"exchange_status": "000000000000000000000000",
"is_archive": false,
"extraFields": {
"order_date": "1555448400",
"delivery_date": "1556485200",
"contract_number": "Дог 1",
"sender": "9864232304319",
"buyer_uuid": "9864232304319",
"doc_num": "АФ00-000001",
"order_number": "1001",
"doc_date": "1556116482",
"action": "4",
"supplier_uuid": "9864232304302",
"delivery_place_uuid": "9864232304562"
},
"tags": [],
"statuses": [],
"multiExtraFields": {}
}
],
"hash": "ABB416F3FF3B5027D212D62DD9F99E94"
}