Method: updateCourseStatus

Permissions to Run the Request

Account Owner, Account Administrators, Department Administrators, Publishers, or custom roles.

Department Administrators, Publishers, 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

Parameter	Type	Description
token (required)	string	Access token. You can obtain a token by making a request.
courseId (required)	string	The ID of the course whose status you would like to edit.
enrollmentIds (required)	string	The IDs of one or more enrollments whose progress you would like to reset.
date (required if the course status is being changed to Completed)	string	The course completion date.
reason (optional)	string	The 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	Type	Description
taskId	string	The ID of the request sent to edit a course's status.

Possible Errors

Error	Description
Unknown content item	The course with the specified ID has not been found.
Permission denied	The 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>
      <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>

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:updateCourseStatusResult>
      <ns1:taskId>100027</ns1:taskId>
    </ns1:updateCourseStatusResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

XML