Method: updateCourseStatus

Permissions to Run the Request

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 courses 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 whose status you would like to edit
enrollmentIds (required)stringThe IDs of one or more enrollments whose progress you would like to reset
date (required if the course status is being changed to Completed)stringThe course completion date
reason (optional)stringThe reason why you want to change the course status
status (required)string

The status you would like to assign to the course

Possible values:

  • complete — the status will be changed to Completed
  • automatic — the status will be recalculated automatically based on the number of modules that were passed

Response Parameters

Parameter

TypeDescription
taskIdstringThe ID of the request sent to edit a course's status

Possible Errors

ErrorDescription
Unknown content itemThe course 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>
      <updateCourseStatusRequest>
        <credentials>
          <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
        </credentials>
        <enrollmentIds>
          <id>e1f2c50e-c1ae-11ea-8592-a6eabe1809b2</id>
        </enrollmentIds>
        <courseId>14b847e8-c10f-11ea-b4e1-ae33e75597e9</courseId>
        <date>2020-07-22</date>
        <reason>Completed offline</reason>
        <status>complete</status>
      </updateCourseStatusRequest>
    </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:updateCourseStatusResult>
      <ns1:taskId>100027</ns1:taskId>
    </ns1:updateCourseStatusResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
  • No labels