Resetting Modules' Progress
AVAILABLE WITH BUSINESS SUBSCRIPTION
Request: DELETE /statistics/module
Note:
- With this method, you can reset progress only on a material that is included in a course. You won't be able to reset progress on a training included in a course using this method.
Permissions to Run the Request
The Account Owner, Account Administrators, Department Administrators, or custom roles.
Department Administrators and users with a custom role can reset the progress of the modules assigned to the users belonging to the departments they manage and their sub-departments.
Request Headers and Parameters
Header | Description |
---|---|
Authorization (required) | Access token. You can obtain a token by making a request. |
Parameter | Description |
courseId (required) | The ID of the course to which one or more modules whose progress you would like to reset belong. |
enrollmentIds (required) | The IDs of one or more enrollments whose progress you would like to reset. |
contentItemIds (required) | The IDs of one or more modules whose progress you would like to reset. |
Response Parameters
Parameter | Description |
---|---|
taskId | The ID of the request sent to reset the modules' progress. |
Possible Response Codes
Code | Text | Description |
---|---|---|
200 | OK | The progress of one or more modules has been successfully reset. |
400 | Bad Request | A request error. |
401 | Unauthorized | An authorization error. |
403 | Permission Denied | The user is not allowed to handle the requested action (not enough permission). |
1 Sample Request
DELETE /statistics/module?courseId=14b847e8-c10f-11ea-b4e1-ae33e75597e9&enrollmentIds[]=82c81e4e-9b34-11ea-91be-e69c92527684&contentItemIds[]=90b54a26-74ca-11ea-be51-aa558f1f0d2b
Host: api-learn.ispringlearn.com
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE
Content-Type:application/xml
XML
2 Sample Request
DELETE /statistics/module?courseId=14b847e8-c10f-11ea-b4e1-ae33e75597e9&enrollmentIds=82c81e4e-9b34-11ea-91be-e69c92527684,88a14532-1628-11ec-aa85-0242ac160034&contentItemIds=90b54a26-74ca-11ea-be51-aa558f1f0d2b,a16940bc-0a37-11ec-9bf1-0242ac140033
Host: api-learn.ispringlearn.com
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE
Content-Type:application/xml
XML
Sample Response
https/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<taskId>9982</taskId>
XML