AVAILABLE WITH BUSINESS SUBSCRIPTION

Method: updateModulesStatuses

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 Parameters

ParameterTypeDescription
token (required)stringAccess token. You can obtain a token by making a request.
courseId (required)stringThe ID of the course to which one or more modules whose progress you would like to reset belong.
enrollmentIds (required)stringThe IDs of one or more enrollments whose progress you would like to reset.
contentItemIds (required)stringThe IDs of one or more modules whose progress you would like to reset.


Response Parameters

Parameter

Type

Description

taskIdstring

The ID of the request sent to reset the modules' progress.

Possible Errors

ErrorDescription
Unknown content itemThe module with the specified ID has not been found.
Permission deniedThe user doesn't have permission to handle the request.

Sample Request

<?xml version="1.0" encoding="utf-8"?>
  <SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
                     xmlns="https://ispringlearn.com/go/services/api/soap">
    <SOAP-ENV:Body>
      <ResetModulesStatisticsRequest>
        <credentials>
          <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
        </credentials>
        <courseId>14b847e8-c10f-11ea-b4e1-ae33e75597e9</courseId>
        <enrollmentIds>
          <id>e1f2c50e-c1ae-11ea-8592-a6eabe1809b2</soap>
        </enrollmentIds>
        <contentItemIds>
          <id>17502fac-c10f-11ea-8fbd-a6eabe1809b2</soap>
        </contentItemIds>
      </ResetModulesStatisticsRequest>
    </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>
XML

Sample Response

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
                   xmlns:ns1="https://ispringlearn.com/go/services/api/soap">    
  <SOAP-ENV:Body>
    <ns1:ResetModulesStatisticsResult>
      <ns1:taskId>100027</ns1:taskId>
    </ns1:ResetModulesStatisticsResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML