API – Звіт з опитування – База знань LMS Collaborator

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

API – Звіт з опитування

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

Для отримання звіту з опитування потрібно надіслати GET запит на URI https://your-domain.davintoo.com/api/v2/polls-report/{id}
Запит повинен містити заголовки Content-Type: application/json;charset=UTF-8 та X-Cbr-Authorization: Bearer API_TOKEN.

Приклад запиту:
curl 'https://your-domain.davintoo.com/api/v2/polls-report/525' -H 'X-Cbr-Authorization: Bearer API_TOKEN' -H 'Content-Type: application/json;charset=UTF-8'

Замість локальної адреси https://your-domain.davintoo.com потрібно використовувати адресу вашого інстанса.

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

taskId - ID завдання
fullname - ім'я користувача
city - Місто
department - Підрозділ
position - Посада

Приклад запиту з пошуком по завданню та імені користувача:
curl 'https://your-domain.davintoo.com/api/v2/polls-report/525?filter[taskId]=3929&filter[fullname]=Balachuk Vika' -H 'X-Cbr-Authorization: Bearer API_TOKEN' -H 'Content-Type: application/json;charset=UTF-8'

Відповідь

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

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

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