Method: updateModulesStatuses

Note:

  • With this method, you can edit the status only of a content item that is included in a course. You won't be able to edit the status of a training included in a course using this method.

Permissions to Run the Request

The Account Owner, Account Administrators, Department Administrators, or custom roles with the 'Can edit' access to the content item. 

Department Administrators and users with a custom role can edit the statuses 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.
enrollmentIds (required)stringThe IDs of one or more enrollments whose statuses you would like to update.
courseId (required)stringThe ID of the course to which one or more modules whose statuses you would like to update belong.
moduleStatuses (required)arrayAn array with the data regarding the module's status. 
contentItemId (required)stringThe ID of the module whose status you would like to update.
date (required)dateThe module completion date.
reason (optional)stringThe reason why you want to change the module's status.
status (required)string

The status you would like to assign to the module. 

Possible values:

  • сomplete
  • incomplete
  • passed
  • failed
  • accepted
  • declined
awardedScore (required)stringThe number of scores earned for the module completion.

Response Parameters

Parameter

TypeDescription
taskIdstringThe ID of the request sent to edit the modules' statuses. 

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 or can't edit the content item. 

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>
      <updateModulesStatusesRequest>
        <credentials>
          <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
        </credentials>
        <enrollmentIds>
          <id>e1f2c50e-c1ae-11ea-8592-a6eabe1809b2</soap>
        </enrollmentIds>
        <courseId>14b847e8-c10f-11ea-b4e1-ae33e75597e9</courseId>
        <moduleStatuses>
          <moduleStatus>
            <contentItemId>17502fac-c10f-11ea-8fbd-a6eabe1809b2</contentItemId>
            <date>2020-03-12</date>
            <reason>Completed offline</reason>
            <status>complete</status>
            <awardedScore>100</awardedScore>
          </moduleStatus>
        </moduleStatuses>
      </updateModulesStatusesRequest>
    </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>

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:updateModulesStatusesResult>
      <ns1:taskId>100027</ns1:taskId>
    </ns1:updateModulesStatusesResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
  • No labels