Getting List of Course Completion Statuses
AVAILABLE WITH BUSINESS SUBSCRIPTION
Method: getContentItemFinalStatuses
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 only retrieve info regarding users belonging to the departments they manage and their sub-departments.
Parameters
Параметр | Тип | Описание |
---|---|---|
credentials (required) | credentials | Read the description of the Credentials object. |
contentItemId (required) | string | ID of a course. |
Return Values
An array with the following properties:
Parameter | Type | Description |
---|---|---|
userId | string | ID of a user. |
status | string | Course status. |
progress | float | Completion progress. |
Possible Errors
Error | Description |
---|---|
Unknown content item | The course with the specified ID hasn't been found. |
Permission denied | The user doesn't have enough permissions to fulfill the request. |
Sample Call
<?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>
<GetContentItemFinalStatusesRequest>
<credentials>
<accountUrl>https://myaccount.ispringlearn.com</accountUrl>
<email>email@email.com</email>
<password>password</password>
</credentials>
<contentItemId>123</contentItemId>
</GetContentItemFinalStatusesRequest>
</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:GetContentItemFinalStatusesResult>
<ns1:statuses>
<ns1:status>
<ns1:userId>265f433a-6214-11e9-b9cf-7ef279cfa744</ns1:userId>
<ns1:status>Passed</ns1:status>
<ns1:progress>100</ns1:progress>
</ns1:status>
<ns1:status>
<ns1:userId>43eb7146-6280-11e9-b274-a6210366ac32</ns1:userId>
<ns1:status>In progress</ns1:status>
<ns1:progress>45.22</ns1:progress>
</ns1:status>
<ns1:status>
<ns1:userId>13172bc2-5aa7-11e9-8b7e-7a64dbc74205</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