База знань LMS Collaborator

Створення оголошень

• Для створення оголошення потрібно надіслати POST запит на URL /api/rest.php/notices
• У тілі запиту має бути JSON об'єкт з інформацією про оголошення.
• Запит повинен містити заголовки Content-Type: application/json;charset=UTF-8 та X-Cbr-Authorization: Bearer API_TOKEN.

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

curl 'https://your-domain.davintoo.com/api/rest.php/notices' -H 'X-Cbr-Authorization: Bearer API_TOKEN' -H 'Content-Type: application/json;charset=UTF-8' --data-binary '{"type": "simple", "title":"LMSCollaboratorBot", "description":"LMSCollaboratorBot will help you to be aware of all important events", "is_published":"1"}'

Формат об'єкта з інформацією про оголошення

*Зірочкою відзначені обов'язкові поля

Відповідь

• В разі успішного запиту (HTTP код відповіді - 200), буде відповідь у форматі JSON з інформацією про створене оголошення:
  {"data":{"id":105,"type": "simple", "title":"LMSCollaboratorBot", "description":"LMSCollaboratorBot will help you to be aware of all important events", "date_begin": null, "date_end": null, "is_published": true,...}

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

Призначення оголошень користувачу

• Для призначення оголошення користувачеві потрібно надіслати POST запит на URL /api/rest.php/notices/{noticeId}?action=assign
• У рядку запиту має бути вказано {noticeId} Id оголошення. У тілі запиту має бути JSON об'єкт із полями:
  user_id - ID користувача
  checked - true
• Запит повинен містити заголовки Content-Type: application/json;charset=UTF-8 та X-Cbr-Authorization: Bearer API_TOKEN.

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

curl 'https://your-domain.davintoo.com/api/rest.php/notices/492?action=assign' -H 'X-Cbr-Authorization: Bearer API_TOKEN' -H 'Content-Type: application/json;charset=UTF-8' --data-binary '{"user_id":5694, "checked":true}'

Відповідь

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

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

Список оголошень

• Для отримання списку створених оголошень потрібно надіслати GET запит на URI /api/rest.php/notices?sorting[created_at]=desc
• Запит повинен містити заголовки Content-Type: application/json;charset=UTF-8 та X-Cbr-Authorization: Bearer API_TOKEN.

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

curl 'https://your-domain.davintoo.com/api/rest.php/notices?sorting[created_at]=desc' -H 'X-Cbr-Authorization: Bearer API_TOKEN' -H 'Content-Type: application/json;charset=UTF-8'

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

title - Назва оголошення
type - Тип оголошення (simple, free, required)
created_at - Дата створення
date_begin - Дата початку
date_end - Дата завершення

Приклад запиту з пошуком по типу оголошення:

curl 'https://your-domain.davintoo.com/api/rest.php/notices?filter[type]=free&sorting[created_at]=desc' -H 'X-Cbr-Authorization: Bearer API_TOKEN' -H 'Content-Type: application/json;charset=UTF-8'

Відповідь

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

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