Отримання списку процесів узгодження¶
Для роботи з цим методом користувач повинен бути авторизованим .
Метод запиту |
HTTPS POST |
---|---|
Content-Type |
application/json (тіло запиту/відповіді в json форматі в тілі HTTPS запиту) |
URL запиту |
https://doc.edin.ua/bdoc/agreement_procs?search_pattern=%D1%81%D0%BE%D0%B3%D0%BB%D0%B0&company_id=1319&status=1&limit=30 |
Параметри, що передаються в URL (разом з адресою методу) |
В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації Опціональні url-параметри:(пошук та фільтри): company_id - ID компанії (вибірка за компанією) search_pattern - пошук за назвою процесу limit - ліміт вибірки (за замовчанням=30) status - статус (1=активний; 2=заблокований) |
JSON-параметри в тілі HTTPS запиту/відповіді¶
REQUEST
В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).
RESPONSE
Опис json-параметрів відповіді метода API (об’єкт AgreementProc)
Таблиця 1 - Опис параметрів об’єкта AgreementProc
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт AgreementProc |
||
agreementProcId |
long |
ID процесу узгодження |
company |
об’єкт; інформація про компанію |
|
companyId |
long |
ID компанії |
name |
String |
назва процесу узгодження |
comment |
String |
коментар |
status |
int |
статус; «1 - активний; 2 - заблокований» |
agreementProc2Docs |
List<AgreementProc2Doc_> |
масив об’єктів; документи, додані до узгодження (+ довідники, якщо ці документи до них прив’язані) |
agrementSteps |
List<AgreementStep_> |
масив об’єктів; налаштування кроку узгодження |
Таблиця 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_> |
масив об’єктів; налаштування відправки повідомлень на пошту |
Приклади¶
При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)
Приклад тіла відповіді (json) - однаковий для Створення/Редагування:
[
{
"agrementSteps": [],
"agreementProc2Docs": [],
"agreementProcId": 195,
"companyId": 1313,
"company": {
"companyId": 0,
"accountId": 0,
"type": 0,
"name": "ФОП Гаврилюк Татьяна",
"code": "3189823647",
"isApproved": 0,
"isSignedOffer": 0,
"isActive": 0,
"certificates": [],
"dictionaries": [],
"notifySettings": []
},
"name": "Согласование актов сверки ",
"status": 1
},
{
"agrementSteps": [],
"agreementProc2Docs": [],
"agreementProcId": 189,
"companyId": 1313,
"company": {
"companyId": 0,
"accountId": 0,
"type": 0,
"name": "ФОП Гаврилюк Татьяна",
"code": "3189823647",
"isApproved": 0,
"isSignedOffer": 0,
"isActive": 0,
"certificates": [],
"dictionaries": [],
"notifySettings": []
},
"name": "Внутреннее согласование заявлений на отпуск ",
"status": 1
},
{
"agrementSteps": [],
"agreementProc2Docs": [],
"agreementProcId": 187,
"companyId": 1319,
"company": {
"companyId": 0,
"accountId": 0,
"type": 0,
"name": "ТОВ Альбатрос ",
"code": "01235896",
"isApproved": 0,
"isSignedOffer": 0,
"isActive": 0,
"certificates": [],
"dictionaries": [],
"notifySettings": []
},
"name": "Cогласования актов вып работ ",
"status": 1
},
]