Отримання списку типів комплектів документів¶
Для роботи з цим методом користувач повинен бути авторизованим .
Метод запиту |
HTTP GET |
---|---|
Content-Type |
application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту) |
URL запиту |
https://doc.edi-n.com/bdoc/extra/package_types |
Параметри, що передаються в URL (разом з адресою методу) |
В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: company_id - ID компанії Опціональні url-параметри status - ID статусу комплекта документів («1 - Активний; 2 - Заблокований; 3 - Чернетка») search_pattern - пошук по признаку типу комплекта документів (фільтр) |
JSON-параметри в тілі HTTP запиту/відповіді¶
REQUEST
В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).
Примітка
В результаті запиту 100 значень вибірки групуються по package_chain_id (ID типу комплекта документів)
RESPONSE
Опис json-параметрів відповіді методу API (масив об’єктів PackageType).
Таблиця 1 - Опис параметрів об’єкта PackageType
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт PackageType |
||
packageId |
long |
id комплекта |
companyId |
long |
id компанії |
name |
String |
назва типу комплекта |
type |
int |
тип документа; ціле число (10); значення за замовчуванням «1», коментар: «1 - File based content; 2 - Structure based content» |
code |
String |
код комплекта |
packageChainId |
long |
незмінний ID комплекта на різних стадіях редагування |
status |
int |
статус; «1 - Активний; 2 - Заблоковано; 3 - Черновик» |
version |
long |
версія комплекту (кількість редакцій) |
dateChanged |
long |
дата останньої зміни комплекта |
autoHandle |
int |
ознака автооброботки комплекта; 0 - ні, 1 - так |
document2packages |
List<Document2Package_> |
масив об’єктів; зв’язок документа і комплекта |
package2dictionaries |
List<Package2Dictionaries_> |
масив об’єктів; зв’язок комплекта і довідника |
extraFields |
List<Package2ExtraField_> |
масив об’єктів; прив’язка додаткових полів до комплекту |
company |
об’єкт; інформація про компанію |
Приклади¶
При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)
Приклад тіла відповіді в json форматі
додати приклад