Получение конкретной цепочки документов¶
Для работы с этим методом пользователь должен быть авторизированным .
С помощью метода api/eds/chain и задаваемых параметров получить (выгрузить) необходимые данные конкретной цепочки документов.
Метод запроса |
HTTP GET |
---|---|
Content-Type |
application/json (тело запроса/ответа в json формате в теле HTTP запроса |
URL запроса |
|
Параметры, передаваемые в URL (вместе с адресом метода) |
В строке заголовка (Header) «Set-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.edi-n.com/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 |
уникальный идентификатор получателя |
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 |
объект; статус пары документов у отправителя и получателя |
|
exchange_status |
String |
сабстатус документа |
is_archive |
boolean |
флаг; «архивный» документ или нет |
signInfo |
объект; данные о подписях |
|
chain |
XChain |
объект; данные связанных цепочек |
extraFields |
Map<String, String> |
массив объектов; набор индексов (аналог индексных таблиц) |
tags |
List<XTag> |
массив объектов; прикрепленные теги |
statuses |
List<XStatus> |
массив объектов; статусы об обработке отправленных документов |
multiExtraFields |
Map<String, List<String>> |
|
Таблица 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)
Параметр |
Формат |
Описание |
---|---|---|
Объект XDocAttachment |
||
id |
long |
id вложения |
docUUID |
UUID |
уникальный идентификатор документа |
fileName |
String |
наименование файла |
createDate |
long |
дата создания вложения; формат unix timestamp |
type |
String |
тип вложения |
base64content |
String |
содержание вложения в BASE64 |
content |
byte[] |
содержание вложения в целочисленном виде |
Таблица 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)
Тип |
Название |
Описание (наименование кириллицей) |
---|---|---|
0 |
all |
all |
1 |
invoice |
Счет |
2 |
orders |
Заказ |
3 |
recadv |
Уведомление о приеме |
4 |
desadv |
Уведомление об отгрузке |
5 |
ordrsp |
Подтверждение заказа |
6 |
pricat |
Прайс-лист |
10 |
declar |
Налоговая накладная |
11 |
insdes |
Инструкция по доставке |
13 |
slsrpt |
Отчет о продажах |
14 |
invrpt |
Отчет об инвентаризации |
15 |
coacsu |
Акт сверки взаиморасчетов |
16 |
actset |
Акт взаимозачета |
17 |
iftmin |
Инструкция о транспортировке |
18 |
retann |
Уведомление о возврате |
19 |
iftmbf |
Заказ транспортировки |
21 |
mscons |
Отчет о предоставленых услугах |
25 |
retins |
Инструкция о возврате |
28 |
comdoc |
Коммерческий документ |
29 |
declarj12 |
Корректировка к налоговой накладной |
30 |
condra |
Не структурированный документ |
42 |
iftmbc |
Подтверждение заказа транспортировки |
59 |
documentinvoice |
Товарная накладная |
67 |
doccorinvoice |
doccorinvoice |
75 |
waybill |
ТТН |
79 |
addbill |
addbill |
98 |
quotes |
Приложение к ув.об отгрузке |
Примеры
Запрос не содержит тела (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"
}