Отримання списку запитів на формування аналітичного звіту¶
Для роботи з цим методом користувач повинен бути авторизованим .
Метод запиту |
HTTP GET |
---|---|
Content-Type |
application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту) |
URL запиту |
https://doc.edin.ua/bdoc/reports |
Параметри, що передаються в URL (разом з адресою методу) |
В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації |
JSON-параметри в тілі HTTP запиту/відповіді¶
REQUEST
В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).
RESPONSE
В Response Header відправляється count - кількість запитів, а в тілі json передається об’єкт Report та Company
Опис json-параметрів відповіді метода API
Таблиця 1 - Опис параметрів об’єкта Report
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт Report |
||
reportName |
String |
назва звіту |
reportId |
long |
ID звіту |
companyId |
long |
ID компанії |
reportStartDate |
long |
дата початку часового періоду звіту (у форматі Unix timestamp) |
reportEndDate |
long |
дата закінчення часового періоду звіту (у форматі Unix timestamp) |
dateCreated |
long |
дата і час запиту на створення звіту (у форматі Unix timestamp) |
dateCompleted |
long |
дата і час створення звіту (у форматі Unix timestamp) |
reportType |
int |
тип звіту; 1 - по зовнішньому документообігу, 2 - по задачам |
userId |
long |
ID користувача |
userEmail |
String |
Email користувача |
reportStatus |
int |
статус звіту; 1 - IN_PROGRESS, 2 - FINISHED |
company |
об’єкт; інформація про компанію |
|
reportFilter |
змінна, в залежності про типу звіту містить об’єкт ReportDocumentFilter або об’єкт ReportTaskFilter |
|
reportFileLink |
String |
посилання на файл |
Таблиця 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):
[
{
"reportName": "Звіт за грудень",
"reportId": 343,
"companyId": 1319,
"reportStartDate": 1573430400,
"reportEndDate": 1576022400,
"dateCreated": 1575976573,
"dateCompleted": 0,
"reportType": 1,
"userId": 683,
"userEmail": "wilfdlnfujkbai@gmail.com",
"reportStatus": 1,
"company": {
"companyId": 1319,
"accountId": 0,
"type": 0,
"name": "ТОВ Альбатрос ",
"code": "01235896",
"isApproved": 0,
"isSignedOffer": 0,
"isActive": 0,
"certificates": [],
"dictionaries": [],
"notifySettings": []
}
},
{
"reportName": "Звіт за грудень",
"reportId": 341,
"companyId": 1319,
"reportStartDate": 1575158400,
"reportEndDate": 1577836800,
"dateCreated": 1575976225,
"dateCompleted": 1575976366,
"reportType": 1,
"userId": 683,
"userEmail": "wilfdlnfujkbai@gmail.com",
"reportStatus": 2,
"company": {
"companyId": 1319,
"accountId": 0,
"type": 0,
"name": "ТОВ Альбатрос ",
"code": "01235896",
"isApproved": 0,
"isSignedOffer": 0,
"isActive": 0,
"certificates": [],
"dictionaries": [],
"notifySettings": []
}
},
{
"reportName": "Аналитика за ноябрь ",
"reportId": 329,
"companyId": 1313,
"reportStartDate": 1572566400,
"reportEndDate": 1575158400,
"dateCreated": 1574429132,
"dateCompleted": 1574429153,
"reportType": 1,
"userId": 693,
"userEmail": "566666798989797zz@gmail.com",
"reportStatus": 2,
"company": {
"companyId": 1313,
"accountId": 0,
"type": 0,
"name": "ФОП Гаврилюк Марьяна",
"code": "3189823647",
"isApproved": 0,
"isSignedOffer": 0,
"isActive": 0,
"certificates": [],
"dictionaries": [],
"notifySettings": []
}
}
]