Getting a List of Course Completion Statuses
You can obtain the completion statuses and scores for all users who viewed the specified course with the getContentItemFinalStatuses method.
Permission to run the request: Account Owner, Administrator, Organization Administrator, Publisher.
Parameters
Parameter | Type | Description |
---|---|---|
credentials (required) | credentials | Read the description of the Credentials object. |
contentItemId (required) | string | ID of a content item. |
Return Value
Returns an array of objects with the following properties:
Parameter | Type | Description |
---|---|---|
userId | string | ID of the specified user. |
status | string | Completion status for the specified user (text status). |
progress | float | Completion progress for the specified user. |
Possible Errors
Error | Description |
---|---|
Unknown content item | Can't find the course with the specified ID. |
Permission denied | User is not allowed to handle the requested action (does not have enough permissions). |
Sample Call
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns="http://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<GetContentItemFinalStatusesRequest>
<credentials>
<accountUrl>http://myaccount.ispringlearn.com</accountUrl>
<email>email@email.com</email>
<password>password</password>
</credentials>
<contentItemId>1234</contentItemId>
</GetContentItemFinalStatusesRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML
Sample Response
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<ns1:GetContentItemFinalStatusesResult>
<ns1:statuses>
<ns1:status>
<ns1:userId>1</ns1:userId>
<ns1:status>Passed</ns1:status>
<ns1:progress>100</ns1:progress>
</ns1:status>
<ns1:status>
<ns1:userId>2</ns1:userId>
<ns1:status>In progress</ns1:status>
<ns1:progress>45.22</ns1:progress>
</ns1:status>
<ns1:status>
<ns1:userId>3</ns1:userId>
<ns1:status>Failed</ns1:status>
<ns1:progress>66.66</ns1:progress>
</ns1:status>
</ns1:statuses>
</ns1:GetContentItemFinalStatusesResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML