Дані документа (об’єкт XDoc)¶
JSON:
{
"body": {
"forms": {
"json": {
"type": {
"id": 2,
"name": "json"
}
}
}
},
"attachments": [],
"comments": [],
"doc_id": 829,
"doc_uuid": "e64a304b-b0c0-454b-a361-5dc5d6987952",
"uuidSender": "0855e1ce-46ed-4995-83b6-356127b95226",
"uuidReceiver": "97bd6618-71b1-45a2-91b2-fe7b888ca00d",
"uuidReceivers": [
"97bd6618-71b1-45a2-91b2-fe7b888ca00d",
"c2394341-85f0-4b8c-8ea9-ff8d3c6c119c"
],
"docNumber": "Пибип0",
"dateCreated": 1589960680,
"dateChanged": 1589960680,
"dateRead": 0,
"docDate": 1587513600,
"chain_id": 0,
"family": 7,
"hash": "65CC9A9F335B5AE07D9E3CD47C55063C",
"type": {
"type": 109,
"title": "ettn",
"description": "ЕТТН"
},
"status": {
"status": 1,
"title": "open"
},
"exchange_status": "000000000000000000000000",
"is_archive": false,
"extraFields": {
"sub_status_date": "1587548202",
"carrier_b_uuid": "97bd6618-71b1-45a2-91b2-fe7b888ca00d",
"doc_num": "Пибип0",
"car_number": "BB1234BB",
"doc_date": "1587513600",
"consignor_b_uuid": "0855e1ce-46ed-4995-83b6-356127b95226",
"customer_b_uuid": "0855e1ce-46ed-4995-83b6-356127b95226",
"driver_b_uuid": "09f4c632-5c37-45ac-a68a-0acfdc157194",
"gross_weight": "1.0",
"consignee_b_uuid": "c2394341-85f0-4b8c-8ea9-ff8d3c6c119c"
},
"tags": [],
"statuses": [],
"multiExtraFields": {
"ettn_delivery_koatuu": [
"1413566500"
],
"ettn_dispatch_koatuu": [
"8000000000"
]
}
}
Таблиця 1 - Опис параметрів об’єкта 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 |
сімейство
|
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“]}. Використовується, наприклад для обробки передаваємого рядка => розбивка рядка за умовою => індексування кожного шматка |
Таблиця 2 - Опис параметрів об’єкта XDocStatus
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocStatus |
||
state |
int |
id статусу |
title |
String |
статус |
Таблиця 3 - Опис параметрів об’єкта XTag
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XTag |
||
id |
long |
id тега |
name |
String |
зміст тега |
shortName |
String |
коротка назва тега |
Таблиця 4 - Опис параметрів об’єкта XStatus
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XStatus |
||
docId |
long |
id документа/квитанції |
date |
long |
дата статусу; формат unix timestamp |
type |
int |
тип статусу |
text |
String |
зміст статусу |
Таблиця 5 - Опис параметрів об’єкта XDocSignInfo
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocSignInfo |
||
doc_id |
long |
id документа/квитанції |
date |
long |
дата підписання; формат unix timestamp |
count |
short |
кількість підписів |
info |
String |
додаткова інформація |
hash |
String |
хеш-значення, отримане в результаті обробки |
Таблиця 6 - Опис параметрів об’єкта XDocCommentsList
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocCommentsList |
||
XDocCommentsList |
List<XDocComment> |
масив об’єктів; коментарі до документа |
Таблиця 7 - Опис параметрів об’єкта XDocComment
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocComment |
||
id |
long |
id коментаря |
docUUID |
UUID |
унікальний ідентифікатор документа |
createTimestamp |
long |
дата створення коментаря у форматі timestamp |
authorLogin |
String |
автор коментаря |
comment |
String |
зміст коментаря |
Таблиця 8 - Опис параметрів об’єкта XDocAttachment
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocAttachment |
||
id |
long |
id вкладення |
docUUID |
UUID |
унікальний ідентифікатор документа |
fileName |
String |
найменування файлу |
createDate |
long |
дата створення вкладення; формат unix timestamp |
type |
String |
тип вкладення |
base64content |
String |
зміст вкладення в BASE64 |
Таблиця 9 - Опис параметрів об’єкта XDocBodyForms
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocBodyForms |
||
forms |
HashMap<String, XDocBody> |
масив об’єктів; тіло документа |
Таблиця 10 - Опис параметрів об’єкта XDocBody
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocBody |
||
type |
об’єкт; тип тіла документа: CONTENT = 1 - зміст в байтах; JSON = 2 - зміст в json форматі; SIGN = 3 - зміст підпису; STAMP = 4; CRYPTED = 5 - зміст в зашифрованому вигляді; UZDRESPONSE = 6 |
|
base64content |
String |
зміст тіла документа в BASE64 |
Таблиця 11 - Опис параметрів об’єкта XDocBodyType
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт XDocBodyType |
||
id |
int |
id типу тіла документа |
name |
String |
назва типу тіла документа |
Таблиця 12 - Опис DocStatus параметрів (об’єкт XDocStatus)
id статусу |
статус |
---|---|
0 |
ALL - будь-який статус |
1 |
OPEN - чернетка (відправник) |
2 |
SENT - відправлений (відправник) |
3 |
DELIVERED - прочитаний (відправник) |
4 |
INBOX - доставлений / вхідний (одержувач) |
5 |
READ - прочитаний (одержувач) |
6 |
ERROR - помилка |
7 |
DELETED - видалений |
Таблиця 13 - Опис параметрів об’єкта XDocType
Параметр |
Тип |
Формат |
Опис |
---|---|---|---|
Об’єкт XDocType |
|||
type |
int |
id типу документа/квитанції |
|
title |
String |
назва документа/квитанции |
|
description |
String |
опис документа/квитанції (найменування кирилицею) |
Таблиця 14 - Опис DocType параметрів (объект XDocType)
Тип |
Назва |
Опис (найменування кирилицею) |
---|---|---|
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 |
|
25 |
retins |
|
28 |
comdoc |
|
29 |
declarj12 |
|
30 |
condra |
|
40 |
prodlist |
|
41 |
agreem |
|
42 |
iftmbc |
|
59 |
documentinvoice |
|
67 |
doccorinvoice |
|
98 |
quotes |
|
111 |
transhipment |
|
117 |
acceptance |
|
113 |
booking |
|
114 |
bookingconfirmation |
|
112 |
completion |
|
118 |
docinvoiceact |
|
119 |
discrepancy |
|
120 |
contrl |
|
121 |
ttn |