API – Звіт з курсу
- Для отримання звіту з курсу потрібно надіслати GET запит на URI https://your-domain.davintoo.com/api/v2/courses/report/{courseId}?page=1&count=10&filter[courseId]={courseId}&sorting[task_finish_date]=desc
- Запит повинен містити заголовки Content-Type: application/json;charset=UTF-8 та X-Cbr-Authorization: Bearer API_TOKEN.
Приклад запиту:
curl 'https://your-domain.davintoo.com/api/v2/courses/report/1309?page=1&count=10&filter[courseId]=1309&sorting[task_finish_date]=desc' -H 'X-Cbr-Authorization: Bearer API_TOKEN' -H 'Content-Type: application/json;charset=UTF-8'
Замість 1309 вказати id курсу.
Запит підтримує фільтрацію за наступними полями:
- ID завданняtaskId
- ПІБ користувачаuser_full_name
- Містоcity
- Підрозділdepartment
- Період за датою завершенняtask_finish_date
Приклад запиту з фільтром за датою завершення курсу:
curl 'https://your-domain.davintoo.com/api/v2/courses/report/1309?page=1&count=10&filter[courseId]=1309&filter[task_finish_date]=2021-11-19&filter[task_finish_date]=2021-12-21&sorting[task_finish_date]=desc' -H 'X-Cbr-Authorization: Bearer API_TOKEN' -H 'Content-Type: application/json;charset=UTF-8'
Відповідь
- В разі успішного запиту (HTTP код відповіді - 200).
Повернеться результат виду:
- масив результатівdata
- об'єкт пагінації (інформація про кількість сторінок, поточну сторінку, результати)pager
- детальна інформація про налаштування курсуcourse
- інформація про ресурси в плані курсу (id та назва)plan
- В разі помилки (HTTP код відповіді - 400) повертає JSON об'єкт з інформацією про помилку