Отримання списку всіх документів на рівні компанії¶
Для роботи з цим методом користувач повинен бути авторизованим .
Метод запиту |
HTTP GET |
---|---|
Content-Type |
application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту) |
URL запиту |
https://doc.edin.ua/bdoc/document_types?company_id=989&type=0&limit=10&offset=0 |
Параметри, що передаються в URL (разом з адресою методу) |
В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: company_id - ID компанії use_type - тип документообігу (1 - external use (зовнішній), 2 - internal use (внутрішній)) Опціональні url-параметри (фільтр) type - тип документу (1 - Файл (неструктурований); 2 - Структура; 3 - Динамічна структура; 4 - Таблиця) limit - ліміт вибірки (за замовчуванням=20) offset - зміщення відносно верхньої межі вибірки (за замовчуванням=0) is_active - статус документу; 1 - активний, 0 - заблокований |
JSON-параметри в тілі HTTP запиту/відповіді¶
REQUEST
В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).
RESPONSE
Опис json-параметрів відповіді методу API (об’єкт Document).
Таблиця 1 - Опис параметрів об’єкта 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_> |
масив об’єктів; дані структурованого документа |
Приклади¶
При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)
Приклад тіла відповіді в json форматі
[
{
"documentId": 2467,
"companyId": 989,
"name": "имя",
"type": 1,
"code": "4324234223425",
"agreementProcId": 0,
"isActive": 1,
"extraFields": []
},
...
{
"documentId": 2385,
"companyId": 989,
"name": "выаыаы",
"type": 1,
"code": "43242342",
"agreementProcId": 0,
"isActive": 1,
"extraFields": []
},
{
"documentId": 2383,
"companyId": 989,
"name": "Для коли",
"type": 1,
"code": "32321321",
"agreementProcId": 0,
"isActive": 1,
"extraFields": []
}
]