Page tree
Skip to end of metadata
Go to start of metadata

To obtain the completion statuses for all users who viewed the course, send the GET request to URL: /content/{content_item_id}/final_statuses.

Permissions to run the request: Account OwnerAdministratorsDepartment Administrators, Publishers.

Department Administrators and Publishers can get statuses only on the users belonging on the departments they manage and their daughter departments.

Request Headers

ParameterDescription
X-Auth-Account-Url (required)Base URL of the account, e.g. http://myaccount.ispringlearn.com
X-Auth-Email (required)Administrator e-mail address.
X-Auth-Password (required)Administrator password.

Possible Response Codes

CodeTextDescription
200OkThe request has been processed successfully.
404Unknown content itemCan't find the course with the specified ID.
403Permission deniedUser is not allowed to handle the requested action (not enough permissions).

Sample Request

GET /content/123/final_statuses HTTP/1.1
Host: api-learn.ispringlearn.com
X-Auth-Account-Url: http://myaccount.ispringlearn.com
X-Auth-Email: email@email.com
X-Auth-Password: password

Sample Response

<?xml version="1.0" encoding="UTF-8"?>
<statuses>
    <status>
        <userId>28199714-a7e4-11e9-bcd3-4289493f2b99</userId>
        <status>Passed</status>
        <progress>90.91</progress>
        <completionDate>2019-10-26T12:35:10+00:00</completionDate>
        <lastViewDate>2019-10-26T12:33:21+00:00</lastViewDate>
    </status>
    <status>
        <userId>2820942e-a7e4-11e9-abaa-4289493f2b99</userId>
        <status>In progress</status>
        <progress>20</progress>
        <lastViewDate>2019-10-23T14:14:13+00:00</lastViewDate>
    </status>
</statuses>

The 'completionDate' value will be included in the xml for completed courses only.

The 'lastViewDate' value appears in the xml if a content items was viewed.

  • No labels