LMS Collaborator knowledge base

Creating notices #

• To create an ad you need to send a POST request to the following URL /api/rest.php/notices
• The body of the request must contain a JSON object with information about the notice.
• The request must contain the headings Content-Type: application/json;charset=UTF-8 and Authorization: Bearer xxxxxx.

Request example:

curl 'http://your-domain.davintoo.com/api/rest.php/notices' -H 'Authorization: Bearer xxxxxx' -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"}'

Format of the object with with information about the ad

*Mandatory fields are marked with an asterisk

Answer

• In case of successful request (HTTP response code - 200), there will be a JSON response with information about the created notice:
  {"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,...}
• In case of error (HTTP response code - 400) it returns JSON object with error information:
  {"title":{"required":"Field cannot be empty"}}

Assigning notices to users #

• To assign a notice to a user, you need to send a POST request to the following URL /api/rest.php/notices/{noticeId}?action=assign
• The request string must contain {noticeId} Id of the notice. The body of the request must contain a JSON object with the following fields:
  user_id - Id of the user
  checked - true
• The query must contain the headings Content-Type: application/json;charset=UTF-8 and Authorization: Bearer xxxxxx. Request example:

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

Answer

• In case of successful request (HTTP response code - 200), the following result will be returned:
  {"data": true}

• In case of error (HTTP response code - 400) it returns JSON object with information about the error

List of notices #

• To get the list of created ads you need to send GET request to the following URI /api/rest.php/notices?sorting[created_at]=desc

• The request must contain the headings Content-Type: application/json;charset=UTF-8 и Authorization: Bearer xxxxxx.

Request example:

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

The request supports filtering by the following fields:

title - The name of the ad
type - Ad type (simple, free, required)
created_at - Date of creation
date_begin - Start date
date_end - Completion date

Example of a request with a search by ad type:

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

Answer

• In case of successful request (HTTP response code - 200), the following result will be returned:
  data - ads array
  pager - pagination object (information about the number of pages, the current page, the number of ads)

• In case of error (HTTP response code - 400) it returns JSON object with error information