База знань LMS Collaborator

Для отримання звіту з чек-листа по всім завданням потрібно:

• надіслати GET запит на URI https://your-domain.davintoo.com/api/v2/check-list/report/{id}
• запит повинен містити заголовки Content-Type: application/json;charset=UTF-8 та X-Cbr-Authorization: Bearer API_TOKEN.
  Приклад запиту:
  curl 'https://your-domain.davintoo.com/api/v2/check-list/report/233'
-H 'X-Cbr-Authorization: Bearer API_TOKEN'
-H 'Content-Type: application/json;charset=UTF-8'

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

position - Посада
city - Місто
department - Підрозділ
tags - Мітка
result_updated_at - Дата заповнення анкети в чек-листі
result_status - Поточний статус анкети в чек-листі

Якщо для чек-листа було створено кілька завдань то щоб не вивантажувати звіт по всім завданням у запиті можна додати фільтр з id завдання та вивантажити результати по конкретному завданю.

Приклад запиту:
curl 'https://your-domain.davintoo.com/api/v2/check-list/report/233?filter[taskId]=36413'
-H 'X-Cbr-Authorization: Bearer API_TOKEN'
-H 'Content-Type: application/json;charset=UTF-8'

Відповідь

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

• В разі помилки (HTTP код відповіді - 400) повертає JSON об'єкт з інформацією про помилку:
  {"title":{"required":"Field cannot be empty"}}

Детальний звіт з чек-листів

Для вивантаження детального звіту по анкетам в чек-листі, де буде вказано назва критерія та обрана оцінка по шкалі, потрібно:

• надіслати GET запит на URI https://your-domain.davintoo.com/api/rest.php/check-lists-result/?action=get-sub-task-details&sub_task_id={id}
• запит повинен містити заголовки Content-Type: application/json;charset=UTF-8 та X-Cbr-Authorization: Bearer API_TOKEN

Приклад запиту:

curl 'https://your-domain.davintoo.com/api/rest.php/check-lists-result/?action=get-sub-task-details&sub_task_id=36419'
-H 'X-Cbr-Authorization: Bearer API_TOKEN'
-H 'Content-Type: application/json;charset=UTF-8'

Відповідь

• В разі успішного запиту (HTTP код відповіді - 200), буде повернено результат виду:
  subTask.element.criteriaGroup - групи критеріїв та критерії;
  subTask.element.scale.answers - варіанти відповіді шкали в чек-листі;
  answers - масив результатів.

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