Додавання (прив’язка) типу комплекта документів до сценарію документообігу¶
Для роботи з цим методом користувач повинен бути авторизованим .
Метод запиту |
HTTPS PUT |
---|---|
Content-Type |
application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту) |
URL запиту |
|
Параметри, що передаються в URL (разом з адресою методу) |
В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: contract_id - ID сценарію документообігу package_chain_id - ID типу комплекта документів sender_type - тип відправника: 1 - клієнт, 2 - власник |
JSON-параметри в тілі HTTPS запиту/відповіді¶
REQUEST
В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).
RESPONSE
У відповідь передаються дані комплекту документів (об’єкт Contract) в json формате
Таблиця 1 - Опис параметрів об’єкта Contract
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт Contract |
||
contractId |
long |
ID сценарію документообігу |
number |
String |
номер документа |
contractName |
String |
назва сценарію документообігу |
date |
long |
дата документа у форматі UNIX TimeStamp |
ownerCompany |
об’єкт; інформація про компанію відправника (власника) |
|
clientCompany |
об’єкт; інформація про компанію одержувача (клієнта) |
|
description |
String |
опис / додаткова інформація |
expiredDate |
long |
дійсний до (дата у форматі UNIX TimeStamp) |
sentDate |
long |
дата відправки у форматі UNIX TimeStamp |
status |
int |
статус; 0 - Чернетка; 1 - Новий; 2 - Прийнято; 3 - Відхилено; 4 - Розірвано; 5 - Чекає підписання; значення за замовчуванням = «0» |
paymentStatus |
int |
ознака, що визначає платника за транзакцію; 0 - Відправник (клієнт), 1 - Одержувач (власник); значення за замовчуванням = «0»; |
isSpecialConditions |
int |
ознака використання спеціальних умов обслуговування |
isAllClientSenderPackages |
int |
відмітка «всі комплекти» для вхідних; 0 - немає, 1 — так |
isAllOwnerSenderPackages |
int |
відмітка «всі комплекти» для вихідних; 0 - немає, 1 — так |
specialConditions |
об’єкт; спеціальні умови |
|
dictionaries |
List<Dictionary> |
масив об’єктів; дані довідників |
tags |
List<Tag_> |
масив об’єктів; дані тегів |
ownerPackages |
List<PackageType> |
масив об’єктів; дані комплектів документів відправника |
clientPackages |
List<PackageType> |
масив об’єктів; дані комплектів документів одержувача |
Таблиця 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 - Опис параметрів об’єкта SpecialConditions
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт SpecialConditions |
||
specialConditionId |
long |
ідентифікатор спеціальних умов обслуговування |
companyId |
long |
id компанії (Компанія-власник сценарію документообігу) |
fileName |
String |
назва файлу |
body |
byte[] |
тіло файлу |
ecomSigns |
byte[] |
підпис E-COM |
ecomSignsInfo |
byte[] |
інформація про сертифікат E-COM |
signInfos |
List<SignInfo_> |
масив об’єктів; інформація про сертифікат користувача |
Таблиця 4 - Опис параметрів об’єкта Dictionary
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт Dictionary |
||
dictionaryId |
long |
id довідника |
companyId |
long |
id компании |
name |
String |
назва довідника |
code |
String |
код довідника |
isActive |
int |
статус довідника; 1 - активний, 0 — заблокований |
values |
List<DictionaryValue> |
масив об’єктів; значення довідника |
Таблиця 5 - Опис параметрів об’єкта DictionaryValue
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт DictionaryValue |
||
valueId |
long |
id значення довідника |
dictionaryId |
long |
id довідника |
name |
String |
назва значення довідника |
code |
String |
код значення довідника |
parentCode |
String |
код «батьківського» значення довідника |
isActive |
int |
статус значення довідника; 1 - активний, 0 - заблокований |
Таблиця 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 |
об’єкт; інформація про компанію |
Приклади¶
При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)
Приклад тіла відповіді в json форматі:
{
"contractId": 2181,
"number": "423434442",
"contractName": "Для Коли2",
"date": 1557446400,
"ownerCompany": {
"companyId": 4,
"accountId": 8,
"type": 1,
"name": "Царь Царей",
"legalName": "ПрАТ \"Літак\"",
"inn": "123456789043",
"code": "34554355",
"phone": "4234234324",
"info": "ewdw",
"isApproved": 1,
"isSignedOffer": 1,
"isActive": 1,
"ownershipTypeId": 4,
"atCode": "12363",
"prsNum": "43242352",
"certNum": "456",
"uuid": "a903de62-5b34-43c9-b73a-fb2b8ee4efc1",
"certificates": [],
"dictionaries": [],
"notifySettings": []
},
"clientCompany": {
"companyId": 20,
"accountId": 14,
"type": 2,
"name": "ФІЗИЧНА ОСОБА",
"code": "3366905914",
"isApproved": 1,
"isSignedOffer": 1,
"isActive": 1,
"ownershipTypeId": 2,
"uuid": "8d20c4a2-f21b-11e8-9806-005056013e25",
"certificates": [],
"dictionaries": [],
"notifySettings": []
},
"expiredDate": 1557446400,
"sentDate": 1557490133,
"status": 1,
"paymentStatus": 0,
"isSpecialConditions": 0,
"isAllClientSenderPackages": 0,
"isAllOwnerSenderPackages": 0,
"dictionaries": [
{
"dictionaryId": 8,
"companyId": 4,
"name": "Регион",
"code": "6",
"isActive": 1,
"values": [
{
"valueId": 625,
"dictionaryId": 8,
"name": "Проверка 2",
"code": "4444444444",
"isActive": 1
}
]
}
],
"ownerPackages": [],
"clientPackages": [
{
"packageId": 1467,
"companyId": 4,
"name": "Тестовый для версий",
"type": 1,
"code": "78965",
"packageChainId": 119,
"status": 1,
"version": 0,
"dateChanged": 1557574242,
"autoHandle": 0,
"document2packages": [],
"package2dictionaries": [],
"extraFields": []
}
]
}