Отримання списку внутрішніх документів¶
Для роботи з цим методом користувач повинен бути авторизованим .
Метод запиту |
HTTP GET |
---|---|
Content-Type |
application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту) |
URL запиту |
https://doc.edin.ua/bdoc/store/internal-documents |
Параметри, що передаються в URL (разом з адресою методу) |
В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: folder - вибір каталога користувача (1- draft (чернетки), 2-sent (відправлені документи)) |
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 - Опис параметрів об’єкта AgreementLogs
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт AgreementLogs |
||
agreementLogId |
long |
ID логу узгодження |
taskId |
long |
ID завдання |
actionType |
int |
тип дії |
dateCreated |
long |
дата створення завдання |
comment |
String |
комментарий |
user |
об’єкт; дані користувача |
Таблиця 6 - Опис параметрів об’єкта DictionaryValue
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт DictionaryValue |
||
valueId |
long |
id значення довідника |
dictionaryId |
long |
id довідника |
name |
String |
назва значення довідника |
code |
String |
код значення довідника |
parentCode |
String |
код «батьківського» значення довідника |
isActive |
int |
статус значення довідника; 1 - активний, 0 - заблокований |
Приклади¶
При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)
Приклад тіла відповіді в json форматі
[
{
"agreementProcId": 142,
"agreementStatus": 1,
"bodies": [],
"clientSignsCount": 0,
"date": 1562584937,
"dateSent": 0,
"documentId": 6428,
"documentType": {
"agreementProcId": 0,
"companyId": 0,
"documentId": 2676,
"extraFields": [],
"isActive": 0,
"isProviderAccess": 0,
"name": "внутренний",
"type": 1,
"useType": 0
},
"documentUuid": "328ca968-45fd-4b4f-8742-9249b049d4f6",
"extraFields": [],
"isReadFromApi": 0,
"number": "1562584937",
"ownerSignsCount": 0,
"packageId": 0,
"senderCompany": {
"accountId": 8,
"certificates": [],
"code": "34554355",
"companyId": 4,
"dictionaries": [],
"inn": "123456789043",
"isActive": 0,
"isApproved": 0,
"isSignedOffer": 0,
"legalName": "ПрАТ \"Літак\"",
"name": "Царь Царей",
"notifySettings": [],
"ownershipTypeId": 0,
"type": 0
},
"senderCompanyId": 4,
"status": 1,
"versionStructure": 0
},
{
"agreementProcId": 142,
"agreementStatus": 1,
"bodies": [],
"clientSignsCount": 0,
"date": 1561646310,
"dateSent": 0,
"documentId": 6235,
"documentType": {
"agreementProcId": 0,
"companyId": 0,
"documentId": 2676,
"extraFields": [],
"isActive": 0,
"isProviderAccess": 0,
"name": "внутренний",
"type": 1,
"useType": 0
},
"documentUuid": "49ee9089-e5f9-49a9-8807-3323ab925f2c",
"extraFields": [],
"isReadFromApi": 0,
"number": "1561646310",
"ownerSignsCount": 0,
"packageId": 0,
"senderCompany": {
"accountId": 8,
"certificates": [],
"code": "34554355",
"companyId": 4,
"dictionaries": [],
"inn": "123456789043",
"isActive": 0,
"isApproved": 0,
"isSignedOffer": 0,
"legalName": "ПрАТ \"Літак\"",
"name": "Царь Царей",
"notifySettings": [],
"ownershipTypeId": 0,
"type": 0
},
"senderCompanyId": 4,
"status": 1,
"versionStructure": 0
}
]