Отримання структури внутрішнього документу¶
Для роботи з цим методом користувач повинен бути авторизованим .
Метод запиту |
HTTP GET |
---|---|
Content-Type |
application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту) |
URL запиту |
https://doc.edi-n.com/bdoc/store/internal-document/structure |
Параметри, що передаються в URL (разом з адресою методу) |
В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: document_id - ID документу |
JSON-параметри в тілі HTTP запиту/відповіді¶
REQUEST
В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).
RESPONSE
Опис json-параметрів відповіді методу API (об’єкт DocumentStore).
Таблиця 1 - Опис параметрів об’єкта DocumentStore
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт DocumentStore |
||
documentId |
long |
id документа |
packageId |
long |
id комплекта |
senderCompanyId |
long |
id організації відправника |
senderCompany |
об’єкт; дані компанії відправника |
|
documentType |
об’єкт; опис типу документу |
|
documentTypeId |
Long |
id типу документу |
number |
String |
номер документу |
date |
long |
дата документу |
dateSent |
long |
дата відправки |
clientSignsCount |
int |
кількість підписів клієнта |
ownerSignsCount |
int |
кількість підписів власника |
status |
int |
статус документа; 2 - відправлений; 3 - прийнятий; 4 - відхилений |
comment |
String |
коментар |
versionStructure |
long |
версія структури структурованого документу |
extraFields |
List<ExtraField> |
масив об’єктів; прив’язка додаткових полів до документа |
bodies |
List<DocumentBody> |
масив об’єктів; тіла документів |
structure |
List<DocStructValue> |
масив об’єктів; опис структури зі значеннями |
agreementLogs |
List<AgreementLogs> |
масив об’єктів; історія / логи узгоджень |
isReadFromApi |
int |
ознака прочитання по API |
documentUuid |
UUID |
унікальний ідентифікатор документа |
agreementProcId |
long |
ID процесу узгодження |
agreementStatus |
int |
статус узгодження |
dictionaryValue |
об’єкт; значення довідника |
Таблиця 2 - Опис параметрів об’єкта Company
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт Company |
||
companyId |
long |
ID компанії |
accountId |
long |
ID аккаунта |
type |
int |
тип компанії (1 - юр. особа; 2 - фіз. особа) |
name |
String |
назва компанії |
legalName |
String |
юридична назва |
inn |
String |
ідентифікаційний номер платника податків |
code |
String |
свідоцтво платника ПДВ |
phone |
String |
телефон |
info |
String |
додаткова інформація |
isApproved |
int |
ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП |
isSignedOffer |
int |
ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так |
isActive |
int |
статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так |
ownershipType |
String |
форма власності |
atCode |
String |
код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України) |
certNum |
String |
свідоцтво платника ПДВ |
uuID |
String |
унікальний ідентифікатор компанії |
bankAcc |
об’єкт; банківські реквізити |
|
legalAddress |
об’єкт; юридична адреса |
|
actualAddress |
об’єкт; фактична адреса |
|
fizName |
об’єкт; ПІБ фіз. особи компанії |
|
certificates |
List<Certificate_> |
масив об’єктів; сертифікати |
dictionaries |
List<Dictionary_> |
масив об’єктів; довідники |
notifySettings |
List<EmailNotifySettings_> |
масив об’єктів; налаштування відправки повідомлень на пошту |
Таблиця 3 - Опис параметрів об’єкта Document
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт Document |
||
documentId |
long |
id документа |
companyId |
long |
id компанії |
company |
об’єкт; інформація про компанію |
|
name |
String |
назва документа |
type |
int |
тип; «1 - Файл; 2 - Структура; 3 - Динамічна структура; 4 - Таблиця» |
code |
String |
код документа |
agreementProcId |
long |
id процесу узгодження |
isActive |
int |
статус; «1 - Активний; 0 - Заблокований» |
extraFields |
List<ExtraField> |
масив об’єктів; додаткові поля документа |
dictionary |
об’єкт; дані довідника |
|
structures |
List<DocumentStructure_> |
масив об’єктів; дані структурованого документа |
Таблиця 4 - Опис параметрів об’єкта DocumentBody
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт DocumentBody |
||
bodyId |
long |
id тіла документа |
documentId |
long |
id документа |
fileName |
String |
найменування файлу |
body |
byte[] |
тіло документа |
signBodies |
List<SignBody_> |
масив об’єктів; тіла підписів на документі |
Таблиця 5 - Опис параметрів об’єкта ExtraField
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт ExtraField |
||
fieldId |
long |
id поля |
companyId |
long |
id компанії |
name |
String |
назва поля |
description |
String |
опис поля |
dataType |
int |
формат поля; 1 - текст; 2 - число; 3 - дата; 4 - цифра |
status |
int |
статус; 1 - Активно, 0 - Неактивно (Заблокировано) |
value |
String |
значення поля |
Таблиця 6 - Опис параметрів об’єкта DocStructValue
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт DocStructValue |
||
id |
String |
ID тега відповідно до опису структури |
value |
String |
значення тега |
index |
int |
номер рядка для масивів, починається з «0» |
structure |
List<List<DocStructValue>> |
масив масивів об’єктів; опис структури зі значеннями |
errors |
List<String> |
масив об’єктів; помилки |
Таблиця 7 - Опис параметрів об’єкта AgreementLogs
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт AgreementLogs |
||
agreementLogId |
long |
ID логу узгодження |
taskId |
long |
ID завдання |
actionType |
int |
тип дії |
dateCreated |
long |
дата створення завдання |
comment |
String |
комментарий |
user |
об’єкт; дані користувача |
Таблиця 8 - Опис параметрів об’єкта DictionaryValue
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт DictionaryValue |
||
valueId |
long |
id значення довідника |
dictionaryId |
long |
id довідника |
name |
String |
назва значення довідника |
code |
String |
код значення довідника |
parentCode |
String |
код «батьківського» значення довідника |
isActive |
int |
статус значення довідника; 1 - активний, 0 - заблокований |
Приклади¶
При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)
Приклад тіла відповіді в json форматі
{
"agreementProcId": 0,
"agreementStatus": 0,
"bodies": [],
"clientSignsCount": 0,
"date": 1562240257,
"dateSent": 0,
"documentId": 6383,
"documentType": {
"agreementProcId": 0,
"code": "82bca6976b564c149f5ee15688e5742a",
"companyId": 4,
"documentId": 2681,
"extraFields": [],
"isActive": 1,
"isProviderAccess": 0,
"name": "Новенький",
"structures": [
{
"dateUpdate": 1562159706,
"encoding": "utf-8",
"id": 2681,
"status": 1,
"structure": [
{
"attribute": false,
"fields": [
{
"attribute": true,
"data": [
{
"index": 0,
"template": " "
}
],
"id": "Empty1",
"optional": true,
"readonly": false,
"title": " ",
"type": {
"string": {
"maxLength": 10,
"minLength": 1
}
}
},
{
"attribute": true,
"data": [
{
"index": 0,
"template": " "
}
],
"id": "Empty1",
"optional": true,
"readonly": false,
"title": " ",
"type": {
"string": {
"maxLength": 10,
"minLength": 1
}
}
},
{
"attribute": true,
"data": [
{
"default": "Генеральному директору ТОВ 'АТС' Клюсі О.М.",
"index": 0
}
],
"id": "Кому",
"optional": true,
"readonly": true,
"title": "Кому:",
"type": {
"string": {
"maxLength": 10,
"minLength": 1
}
}
},
{
"attribute": true,
"data": [
{
"index": 0,
"template": "Прошу надати мені відпустку без збереження заробітної плати "
}
],
"id": "ОснТекст",
"optional": true,
"readonly": false,
"title": " ",
"type": {
"string": {
"maxLength": 100,
"minLength": 1
}
},
"viewType": "text-area"
},
{
"attribute": true,
"data": [
{
"index": 0,
"template": "Юзер:user:#user.fio#"
}
],
"id": "User",
"optional": true,
"readonly": false,
"title": "Юзер",
"type": {
"string": {
"maxLength": 500,
"minLength": 1
}
}
}
],
"id": "Заява",
"optional": true,
"readonly": false,
"title": "Заява на відпустку без збереження заробітної плати",
"type": {
"object": {}
}
}
],
"version": 10
}
],
"type": 2,
"useType": 2
},
"documentUuid": "abfa6629-4feb-48ae-943b-9e643e1f2700",
"extraFields": [],
"isReadFromApi": 0,
"number": "1562240257",
"ownerSignsCount": 2,
"packageId": 0,
"senderCompanyId": 4,
"status": 1,
"structure": [
{
"id": "Заява",
"index": 0,
"structure": [
[
{
"id": "Empty1",
"index": 0,
"value": " "
},
{
"id": "ОснТекст",
"index": 0,
"value": "Прошу надати мені відпустку без збереження заробітної плати "
},
{
"id": "Підрозділ",
"index": 0,
"value": "пвапавпв"
},
{
"id": "Вособsaі",
"index": 0,
"value": "вы"
},
{
"id": "User",
"index": 0,
"value": "Юзер:user:Ляшенко евгений"
}
]
]
}
],
"versionStructure": 10
}