You can retrieve results for the entire account, for certain learners and courses, specify the statuses of users and courses, start, completion, and due dates. |
Permissions to Run the Request
Account Owner, Account Administrators, Department Administrators, or a user with a custom role.
Department Administrators can get results of the users belonging to the departments they manage and their sub-departments.
| Parameter | Type | Description |
|---|---|---|
| enrollmentIds (optional) | The ID of an enrollment you want to get information on | |
| token (required) | string | Access token. You can obtain a token by making a request |
| userIds (optional) | string | An array of IDs of the users whose results you want to retrieve |
| courseIds (optional) | string | An array of IDs of the courses which results you want to retrieve |
| accessDate[startDate], accessDate[endDate] (optional) | string | The time range for course assignment date. This parameter can be limited only by one point |
| dueDate[startDate], dueDate[endDate] (optional) | string | The time range for course due date. This parameter can be limited only by one point |
| completionDate[startDate], completionDate[endDate] (optional) | string | The time range for course completion date. This parameter can be limited only by one point |
| completionStatuses (optional) | string | The statuses of courses which results you would like to retrieve. Possible values are: not_started, in_progress, pending, complete, passed, accepted, incomplete, failed, declined |
| departmentIds (optional) | string | An array of IDs of the departments whose results you want to retrieve |
| userStatuses (optional) | number | The user status. Possible values are: 1 — active, 3 — blocked. By default, the response shows data on active users |
| pageSize (optional) | number | The number of entries per page. If not indicated, equal to 1000 |
| pageToken (optional) | string | The token needed to continue to the next page |
After the request is successfully processed, the system returns an object with the following properties:
Parameter | Type | Description |
|---|---|---|
| learnersResults [] | array | An array data on learners' level of training |
| userId | string | The user ID |
| courseId | string | The course ID |
| courseTitle | string | The course title |
| sessionId | string | The session ID This parameter appears if there is a training in the course |
| enrollmentId | string | The enrollment ID |
| accessDate | string | Start date of the course |
| dueDate | string | Course completion date. This parameter is specified in the response if the course completion date has been defined |
| expirationDate | string | Course completion date. This parameter is specified in the response if access to the course will be closed after the completion date |
| completionDate | string | Course completion date |
| duration | string | If users are enrolled in a video or training session, this parameter will appear if the course has a recommended duration |
| timeSpent | string | Time taken to complete the course |
| completionStatus | string | Course completion status Possible values: not_started, |
| progress | string | Course progress |
| awardedScore | string | Score awarded for the course |
| isOverdue | string | Whether or not the course has expired. Possible values: 0 — the course has not expired |
| viewsCount | string | Number of times a user has viewed a course |
| nextPageToken | string | The token needed to continue to the next page |
Error | Description |
|---|---|
| Permission denied | The user doesn't have permission to complete the request. For example, Department Administrator can't get results of users belonging to a department they don't manage |
<?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>
<ListLearnersResultsRequest>
<credentials>
<token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
</credentials>
<userIds>
<id>25e44840-87a0-11e9-897c-0a580af40783</id>
</userIds>
<courseIds>
<id>596e5f20-8c46-11e9-a814-0a580af4024a</id>
</courseIds>
<accessDate>
<startDate>2019-01-06T00:00:00+00:00</startDate>
<endDate>2019-31-12T00:00:00+00:00</endDate>
</accessDate>
<dueDate>
<startDate>2019-01-12T00:00:00+00:00</startDate>
<endDate>2019-31-12T00:00:00+00:00</endDate>
</dueDate>
<completionDate>
<startDate>2019-01-12T00:00:00+00:00</startDate>
<endDate>2019-31-12T00:00:00+00:00</endDate>
</completionDate>
<completionStatuses>
<value>complete</value>
</completionStatuses>
<departmentIds>
<id>81826672-9e49-11e9-b4fc-0a580af40235</id>
</departmentIds>
<userStatuses>
<value>1</value>
<value>3</value>
</userStatuses>
<pageToken>MGJiYjhlZGMtMjcwMS0xMWVhLTljYzgtMGE1ODBhZjQwYzRm</pageToken>
<pageSize>100</pageSize>
</ListLearnersResultsRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope> |
<?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>
<ListLearnersResultsResult>
<learnersResults>
<learnerResult>
<userId>6b0dfde6-9e69-11e9-8e2c-0a580af404f9</userId>
<courseId>e1175540-ae0f-11e9-b49e-0a580af405b3</courseId>
<courseTitle>Course 1</courseTitle>
<enrollmentId>1777fdf0-232d-11ea-a24a-0a580af40c27</enrollmentId>
<accessDate>2019-12-25T01:00:00+00:00</accessDate>
<dueDate>2019-12-27T21:00:00+00:00</dueDate>
<expirationDate>2019-12-27T21:00:00+00:00</expirationDate>
<completionStatus>not_started</completionStatus>
<progress>0</progress>
<isOverdue>true</isOverdue>
</learnerResult>
<learnerResult>
<userId>1529eee6-adee-11e9-a5d9-0a580af40906</userId>
<courseId>9789a1ec-adee-11e9-b1b5-0a580af40906</courseId>
<courseTitle>Course 2</courseTitle>
<enrollmentId>a2cadee0-adee-11e9-b31d-0a580af40909</enrollmentId>
<accessDate>2019-07-24T00:00:00+00:00</accessDate>
<timeSpent>127</timeSpent>
<completionStatus>in_progress</completionStatus>
<progress>80</progress>
<awardedScore>13.64</awardedScore>
<isOverdue>false</isOverdue>
<viewsCount>2</viewsCount>
</learnerResult>
<learnerResult>
<userId>0569aad2-adee-11e9-b6c5-0a580af40906</userId>
<courseId>1b70b088-ae06-11e9-b7d8-0a580af405b3</courseId>
<courseTitle>Course 3</courseTitle>
<enrollmentId>3d4776b0-ae06-11e9-9707-0a580af4013b</enrollmentId>
<accessDate>2019-07-24T00:00:00+00:00</accessDate>
<completionDate>2019-07-24T11:30:07+00:00</completionDate>
<timeSpent>41006</timeSpent>
<completionStatus>complete</completionStatus>
<progress>100</progress>
<isOverdue>false</isOverdue>
<viewsCount>3</viewsCount>
</learnerResult>
<learnerResult>
<userId>1529eee6-adee-11e9-a5d9-0a580af40906</userId>
<courseId>1a6bc896-aec2-11e9-8955-0a580af406a3</courseId>
<courseTitle>Course 4</courseTitle>
<enrollmentId>296bdbd8-aec2-11e9-aee5-0a580af402ea</enrollmentId>
<accessDate>2019-07-25T00:00:00+00:00</accessDate>
<completionDate>2019-07-25T09:55:37+00:00</completionDate>
<timeSpent>37</timeSpent>
<completionStatus>complete</completionStatus>
<progress>100</progress>
<isOverdue>false</isOverdue>
<viewsCount>2</viewsCount>
</learnerResult>
</learnersResults>
<nextPageToken>MGJiYjhlZGMtMjcwMS0xMWVhLTljYzgtMGE1ODBhZjQwYzRm</nextPageToken>
</ListLearnersResultsResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope> |