...
| Info |
|---|
You can retrieve results for the entire account, for certain learners, courses, and modules, specify the statuses of users and courses, start, completion, and due dates. Learn how to get a list of all course modules in the Getting a List of Course Modules article. |
Permissions to Run the Request
...
Department Administrators and users with a custom role can get results of users belonging to the departments they manage and their sub-departments.
RequestHeaders
Header | Description |
|---|---|
| Authorization (required) | Access token. You can obtain a token by making a request |
Request Parameters
Parameter | Description |
|---|---|
| userIds (optional) | An array of IDs of the users whose results you want to retrieve |
| courseIds (optional) | An array of IDs of the courses which results you want to retrieve |
| moduleIds (optional) | The course module ID |
| courseItemIds (optional) | An array of IDs of the course modules which results you want to retrieve |
| enrollmentIds (optional) | An array of IDs of the enrollments which results you want to retrieve |
| accessDate[startDate], accessDate[endDate] (optional) | The time range for course assignment date. This parameter can be limited only by one point |
| dueDate[startDate], dueDate[endDate] (optional) | The time range for course due date. This parameter can be limited only by one point |
| completionDate[startDate], completionDate[endDate] (optional) | The time range for course completion date. This parameter can be limited only by one point |
| completionStatuses (optional) | The statuses of courses which results you would like to retrieve. Possible values are: not_started, in_progress, pending, complete, passed, accepted, incomplete, failed, declined |
| departmentIds (optional) | An array of IDs of the departments whose results you want to retrieve |
| userStatuses (optional) | The user status. Possible values are: 1 — active, 3 — blocked. By default, the response shows data on active users |
| pageSize (optional) | The number of entries per page. If not indicated, equal to 1000 |
| pageToken (optional) | The token to continue to the next page |
ResponseParameters
Параметр | Описание |
|---|---|
result | An array of dataabout the user's results based on coursemodules |
| userId | The user ID |
| courseId | The course ID |
| moduleId | The module ID |
| moduleTitle | The module title |
| courseItemId | The ID of the couse item or a training belonging to the course. This parameter indicates the ID of a course item or a training assigned to it in the account, outside the course, and doesn't coincide with the moduleId parameter. |
| enrollmentId | The enrollment ID |
| accessDate | The date when the learner started studying the course |
| dueDate | Course due date. The parameter appears in the response if a due date is specified |
| expirationDate | Course expiration date. The parameter will appear in the response if access to the course is going to be closed after the deadline. |
| completionDate | Course completion date |
| timeSpent | Time spent completing the course |
| completionStatus | The coursecompletionstatus Possible values:
|
| progress | Courseprogress |
| isOverdue | Possible values:
|
| viewsCount | The number of views of the course by users |
Response Codes
Code | Text | Description |
|---|---|---|
| 200 | OK | The request has been successfully processed. The response body contains the XML data regarding users results |
| 400 | Bad Request | A request error |
| 401 | Unauthorized | An authorization error |
| 403 | Permission Denied | The user doesn't have enough permissions to retrieve user results |
Sample Request
| Code Block | ||
|---|---|---|
| ||
GET/learners/modules/results?userIds[]=85077abc-2639-11ea-8e3f-0a580af40c09&courseIds[]=f0e7400a-ca31-11e9-b6fc-0a580af40a22&moduleIds[]=5a98720f-41e2-11ea-8a66-0a580af40c6f&moduleIds[]=55e716fa-3c5c-11ef-96f2-02420a200177&moduleIds[]=6657451e-3c5c-11ef-ae43-02420a200177&accessDate[startDate]=2019-12-24T21:00:00Z&accessDate[endDate]=2020-12-30T03:00:00Z&dueDate[startDate]=2019-08-30T03:00:00Z&dueDate[endDate]=2019-12-30T03:00:00Z&completionDate[startDate]=2019-08-30T03:00:00Z&completionDate[endDate]=2019-12-30T03:00:00Z&completionStatus=failed&departmentIds[]=f0b2d3c0-aded-11e9-bfe6-0a580af40906&userStatuses[]=1&pageSize=33&pageToken=MmEzZTBiMjAtYmNmYi0xMWU5LTk2ODUtMGE1ODBhZjQwOTVj https/1.1 Host: api-learn.ispringlearn.com Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE |
...