Зміна статусу комплекту¶
Для роботи з цим методом користувач повинен бути авторизованим .
Метод запиту |
HTTPS POST |
---|---|
Content-Type |
application/json/form-data (тіло запиту в form-data в тілі HTTPS запиту) |
URL запиту |
https://doc.edin.ua/bdoc/store/package/status |
Параметри, що передаються в URL (разом з адресою методу) |
В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації |
JSON-параметри в тілі HTTPS запиту/відповіді¶
REQUEST
В тілі запиту в form-data передаються параметри.
Таблиця 1 - Опис json-параметрів запиту метода API
Параметр |
Mandatory/Optional |
Формат |
Опис |
---|---|---|---|
package_id |
M |
int |
ID пакета |
status |
M |
int |
ID статусу (3 - Прийнято; 4 - Запит на уточнення; 5 - Відхилено; 6 - Опрацьовано; 7 - Відмова) |
RESPONSE
У відповідь передаються дані комплекту (об’єкт Package) в json форматі
Таблиця 6 - Опис параметрів об’єкта 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 |
об’єкт; інформація про компанію |
Приклади¶
В тілі запиту в form-data передаються дані комплекту.
Приклад тіла відповіді в json форматі
{
"packageId": 7535,
"senderCompanyId": 1319,
"recipientCompanyId": 4,
"senderCompany": {},
"recipientCompany": {},
"contract": {},
"packageTypeId": 2353,
"packageTypeChainId": 330,
"dateCreated": 1576479459,
"dateChanged": 1576760119,
"status": 3,
"archive": 0,
"packageNumber": "1576252943",
"documents": [],
"package2Dictionaries": [],
"extraFields": [],
"contractDictionaries": [],
"packageTags": [
{
"tagId": 227,
"name": "с ексели",
"code": "7e5708a30a1348d8acea9b86041c9824"
}
],
"packageType": {
"packageId": 2353,
"companyId": 1319,
"name": "Договора аренды на КОМОД",
"type": 1,
"code": "dcb8e60a6ffa4a5cafd2b4cdd405527d",
"packageChainId": 330,
"status": 2,
"version": 2,
"dateChanged": 1574850008,
"autoHandle": 0,
"document2packages": [],
"package2dictionaries": [],
"extraFields": []
},
"isRead": 1,
"isReadFromApi": 0,
"isReadyForSend": 0,
"packageDirection": 1,
"signDateTerm": 0,
"packageUuid": "f30c55dd-47cf-4a82-a07c-0be2c95b8716",
"isWithAgreement": 0
}