LMS Collaborator knowledge base

Home/Technical requirements/API/API - Course Report

API – Course Report

Request example:
curl 'http://localhost:8080/api/v2/courses/report/1212?page=1&count=10&filter[courseId]=1212&sorting[task_finish_date]=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 - results array
pager - pagination object (information about the number of pages, the current page, the number of results)
course - detailed information about course settings
plan - information about resources in the course plan (id and title)

The request supports filtering by the following fields:

  • taskId - Task ID
  • userId - User ID
  • city - City
  • department - Department
  • task_finish_date - period by date of completion

An example of a query with a filter by date of course completion:
curl 'http://localhost:8080/api/v2/courses/report/1212?page=1&count=10&filter[courseId]=1212&filter[task_finish_date]=2020-07-29&filter[task_finish_date]=2020-07-29&sorting[task_finish_date]=desc' -H 'Authorization: Bearer xxxxxx' -H 'Content-Type: application/json;charset=UTF-8'


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

Still have questions?
Our technical support team is always happy to help!
Write to us at technical support [email protected]. If you are registered on our Helpdesk - send request button below.
Send request