API – Зведений звіт – База знань LMS Collaborator

Головна/Технічні вимоги/Робота з API/API - Зведений звіт

API – Зведений звіт

Для авторизації використовуйте АРІ token. Детально в статті API token

Для отримання зведеного звіту з результатами навчання одного або групи вибраних користувачів, вибравши необхідне завдання (чи кілька завдань) потрібно надіслати POST запит на URI https://your-domain.davintoo.com/api/v2/tasks/summary-report

В тілі запиту має бути JSON об'єкт з інформацією про обраних користувачів та завдання.
Запит повинен містити заголовки Content-Type: application/json;charset=UTF-8 та X-Cbr-Authorization: Bearer API_TOKEN.

Приклад запиту:
curl -X POST 'https://your-domain.davintoo.com/api/v2/tasks/summary-report' --data-raw '{"page":1,"count":10,"filter":{},"sorting":{"user_full_name":"asc"},"filterData":{"tasks":[31066,27292],"users":[4172,4849,5430]}}'
-H 'X-Cbr-Authorization: Bearer API_TOKEN'
-H 'Content-Type: application/json;charset=UTF-8'

Замість локальної адреси https://your-domain.davintoo.com потрібно використовувати адресу вашого інстанса. У полі tasks масив id завдань, у полі users масив id користувачів, у полі filter додаткові фільтри.

Запит підтримує фільтрацію по наступним полям:

fullname - ПІБ
position - Посада
city - Місто
department - Підрозділ
tags - мітка

Відповідь

В разі успішного запиту (HTTP код відповіді - 200), буде повернено результат виду:

data - масив результатів
pager - об'єкт пагінації (інформація про кількість сторінок, поточну сторінку, к-сті результатів)

В разі помилки (HTTP код відповіді - 400) повертає JSON об'єкт з інформацією про помилку