############################################################# **Створення запиту на формування аналітичного звіту** ############################################################# Для роботи з цим методом користувач повинен бути `авторизованим `__ . +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | **Метод запиту** | **HTTP POST** | +================================================================+============================================================================================================+ | **Content-Type** | application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту) | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | **URL запиту** | **https://doc.edin.ua/bdoc/report** | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | **Параметри, що передаються в URL (разом з адресою методу)** | В рядку заголовка (Header) "Set-Cookie" обов'язково передається **SID** - токен, отриманий при авторизації | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | **Обов'язкові параметри, що передаються в тілі запиту (json)** | **reportType (визначає тип звіту), reportName, companyId, reportStartDate, reportEndDate** | +----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ **JSON-параметри в тілі HTTP запиту/відповіді** ******************************************************************* ``REQUEST`` Опис json-параметрів **запиту** метода API: Таблиця 1 - Опис параметрів запиту +-----------------+--------------------+--------+---------------------------------------------------------------------------------------------+ | Параметр | Mandatory/Optional | Формат | Опис | +=================+====================+========+=============================================================================================+ | reportType | M | int | тип звіту; 1 - по зовнішньому документообігу, 2 - по завданням | +-----------------+--------------------+--------+---------------------------------------------------------------------------------------------+ | reportName | M | String | назва звіту | +-----------------+--------------------+--------+---------------------------------------------------------------------------------------------+ | companyId | M | long | ID компанії | +-----------------+--------------------+--------+---------------------------------------------------------------------------------------------+ | reportFilter | O | об'єкт | в залежності від reportType, містить або "partnerCompanyId", або "taskUser" та "taskUserId" | +-----------------+--------------------+--------+---------------------------------------------------------------------------------------------+ | reportStartDate | M | long | дата початку часового періоду звіту (Unix timestamp) | +-----------------+--------------------+--------+---------------------------------------------------------------------------------------------+ | reportEndDate | M | long | дата закінчення часового періоду звіту (Unix timestamp) | +-----------------+--------------------+--------+---------------------------------------------------------------------------------------------+ ``RESPONSE`` Опис json-параметрів **відповіді** метода API (об'єкт **Report**) Таблиця 2 - Опис параметрів об'єкта **Report** .. csv-table:: :file: for_csv/Report.csv :widths: 1, 12, 41 :header-rows: 1 :stub-columns: 0 Таблиця 3 - Опис параметрів об'єкта **ReportDocumentFilter** .. csv-table:: :file: for_csv/ReportDocumentFilter.csv :widths: 1, 12, 41 :header-rows: 1 :stub-columns: 0 Таблиця 4 - Опис параметрів об'єкта **ReportTaskFilter** .. csv-table:: :file: for_csv/ReportTaskFilter.csv :widths: 1, 12, 41 :header-rows: 1 :stub-columns: 0 -------------- **Приклади** ***************** Приклад тіла **запиту** (json) для **Створення звіту по зовнішньому документообігу**: .. code:: ruby { "reportType": 1, "reportFilter": { "partnerCompanyId": 4 }, "reportName": "тижневий звіт", "companyId": 1313, "reportStartDate": 1572566800, "reportEndDate": 1575244600 } -------------- Приклад тіла **відповіді** (json): .. code:: ruby { "reportName": "тижневий звіт", "reportId": 339, "companyId": 1319, "reportStartDate": 1575244800, "reportEndDate": 1575849600, "dateCreated": 1575910632, "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": [] } } --------------