AVAILABLE WITH BUSINESS SUBSCRIPTION

Method: getTaskStatus

Permissions to Run the Request

Account OwnerAccount AdministratorsDepartment Administrators, or custom roles with the 'Can edit' access to the content item. 

Department Administrators and users with custom roles can get the ID of the request sent to update the status of a course or a module 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
task_id (required)stringThe ID of the request whose status you want to get

Response Parameters

Parameter

TypeDescription
statusstring

The completion status of the request sent to edit a course or a module status

Possible values:

  • complete
  • failed
  • in progress

Possible Errors

ErrorDescription
Unknown content itemThe request ID hasn't 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>
      <getTaskStatusRequest>
        <taskId>100027</taskId>
      </getTaskStatusRequest>
    </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:getTaskStatusResult>
      <ns1:status>complete</ns1:status>
    </ns1:getTaskStatusResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML