Getting a List of Assignments
AVAILABLE WITH BUSINESS SUBSCRIPTION
Request: GET /assignments
Permissions to Run the Request
Account Owner, Account Administrators, Department Administrators or custom roles that allow to grade assignments.
Request Headers
Header | Description |
---|---|
Authorization (required) | Access token. You can obtain a token by making a request. |
Parameter | Description |
ungraded (optional) | This parameter helps to filter attempts that are not evaluated by instructor. If it is not specified, all ungraded assignments will be returned. If there is 1, all ungraded assignments will be returned. If there is 0, all assignments will be returned. |
pageSize (optional) | The number of entries per page. If not indicated, equal to 1000. |
pageToken (optional) | The token to continue to the next page. It is not indicated fot the first page. |
Response Parameters
Parameter | Description |
---|---|
assignments | An array containing information about the assignments. |
assignmentId | The ID of the assignment. |
title | The name of the assignment. |
Note:
Deleted assignments are not included in the list.
Response Codes
Code | Text | Description |
---|---|---|
200 | Successful operation | The request has been successfully processed. |
400 | Bad Request | A request error. |
401 | Unauthorized | An authorization error. |
403 | Permission Denied | The user doesn't have enough permissions to user results. |
Sample Request
GET/learners/results?userIds[]=85077abc-2639-11ea-8e3f-0a580af40c09&courseIds[]=f0e7400a-ca31-11e9-b6fc-0a580af40a22&accessDate[startDate]=2019-12-24T21:00:00Z&accessDate[endDate]=2020-12-30T03:00:00Z&dueDate[startDate]=2019-08-30T03:00:00Z&dueDate[endDate]=2019-12-30T03:00:00Z&completionDate[startDate]=2019-08-30T03:00:00Z&completionDate[endDate]=2019-12-30T03:00:00Z&completionStatus=failed&departmentIds[]=f0b2d3c0-aded-11e9-bfe6-0a580af40906&userStatuses[]=1&pageSize=33&pageToken=MmEzZTBiMjAtYmNmYi0xMWU5LTk2ODUtMGE1ODBhZjQwOTVj
https/1.1
Host: api-learn.ispringlearn.com
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE
XML
Sample Response
https/1.1 200 Successful operation
Connection: close
<?xml version="1.0" encoding="UTF-8"?>
<response>
<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>
</response>
XML