Відправка коментаря до комплекта документів¶
Для роботи з цим методом користувач повинен бути авторизованим .
Метод запиту |
HTTP POST |
---|---|
Content-Type |
application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту) |
URL запиту |
https://doc.edin.ua/bdoc/store/package/comment?package_id=5261 |
Параметри, що передаються в URL (разом з адресою методу) |
В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Обов’язкові url-параметри: package_id - ID комплекта документів, до якого необхідно відправити документ |
JSON-параметри в тілі HTTP запиту/відповіді¶
REQUEST
В тілі запиту методу API передається текст коментаря в вигляді рядка ( comment ).
RESPONSE
Опис json-параметрів відповіді метода API (масив об’єктів PackageComments)
Таблиця 1 - Опис параметрів об’єкта PackageComments
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт PackageComments |
||
commentId |
long |
id коментаря |
packageId |
long |
id комплекту |
user |
об’єкт; дані користувача |
|
action |
int |
дія; тип операції |
comment |
Comment |
об’єкт; коментар |
date |
long |
дата коментаря |
Таблиця 2 - Опис параметрів об’єкта Comment
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт Comment |
||
before |
Changes |
об’єкт; зміни (коментар до) |
after |
Changes |
об’єкт; зміни (коментар після) |
userComment |
String |
коментар користувача |
documentId |
Long |
ID документа |
Таблиця 3 - Опис параметрів об’єкта User
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт User |
||
userId |
long |
ID користувача |
accountId |
long |
ID аккаунта |
String |
email та логін користувача |
|
password |
String |
пароль користувача |
isOwner |
int |
ознака власника аккаунта; 0 - ні, 1 - так |
isCaptcha |
Integer |
ознака активації CAPTCHA для користувача («1» - активна; «0» - не активна) |
fio |
String |
ПІБ користувача |
tel |
String |
телефон |
companies |
List<Company_> |
масив об’єктів; компанії |
account |
об’єкт; дані облікового запису |
|
status |
int |
статус користувача («1» - активний; «2» - заблокований) |
roles |
List<Role_> |
масив об’єктів; ролі |
routes |
List<PackageRoute_> |
масив об’єктів; маршрути |
passSecureType |
int |
рівень складності пароля («1» - низький; «2» - звичайний; «3» - високий) |
passPolicyId |
long |
id пральний політики, застосованої до користувача |
userInfo |
об’єкт; інформація про користувача |
|
lastLoginIp |
String |
IP-адреса останнього входу |
lastLoginDate |
long |
дата останнього входу |
uiTypes |
List<UIType2Role_> |
масив об’єктів; зв’язки користувальницьких інтерфейсів і ролей |
Приклади¶
В тілі запиту (json) передається текст коментаря в вигляді рядка ( comment )
Приклад тіла відповіді в json форматі
[
[
{
"commentId": 1960,
"packageId": 5261,
"user": {
"userId": 0,
"accountId": 0,
"email": "sashabelovv@meta.ua",
"isOwner": 0,
"fio": "Ляшенко евгений",
"tel": "34324322",
"companies": [],
"status": 0,
"roles": [],
"routes": [],
"passSecureType": 0,
"passPolicyId": 0,
"lastLoginDate": 0,
"uiTypes": [],
"userAccess": {}
},
"action": 3,
"comment": {
"before": {
"status": 6
},
"after": {
"status": 6
},
"userComment": "121212"
},
"date": 1561036190
},
{
"commentId": 1959,
"packageId": 5261,
"user": {
"userId": 0,
"accountId": 0,
"email": "lyashenko270619933@meta.ua",
"isOwner": 0,
"fio": "Личный раб",
"tel": "423423",
"companies": [],
"status": 0,
"roles": [],
"routes": [],
"passSecureType": 0,
"passPolicyId": 0,
"lastLoginDate": 0,
"uiTypes": [],
"userAccess": {}
},
"action": 1,
"comment": {
"before": {
"status": 3
},
"after": {
"status": 6
}
},
"date": 1560517761
}
]
]