Each user enrolled in a course section has a completion object with information about the student's progress in the section.
Table of Contents
Fields
| Field | Name | Description | Type | Required |
uid | User Id | The Schoology user id of the user | string | |
total_rules | Total Rules | The total number of completion rules for the user for the section | integer | |
completed_rules | Completed Rules | The total number of rules the user has completed for the section | integer | |
percent_complete | Percent Complete | The percentage of the section the user has completed. | float | |
completed | Completed? | Whether the section has been completed by the user | {0,1} | |
Operations
list
View a list of section completion objects
| Path | GET https://api.schoology.com/v1/sections/{section_id}/completion |
| Content | none |
| Return | A collection of section completion objects, each one containing section completion fields JSON {
"completion": [
{
"uid": 48289,
"total_rules": 2,
"completed_rules": 0,
"percent_complete": 0,
"completed": 0
}
],
"total": 1,
"links": {
"self": "http:\/\/...?start=0&limit=20"
}
}
XML <?xml version="1.0" encoding="utf-8" ?>
<result>
<completion>
<uid>48289</uid>
<total_rules>2</total_rules>
<completed_rules>0</completed_rules>
<percent_complete>0</percent_complete>
<completed>0</completed>
</completion>
<total>1</total>
<links>
<self>http:\/\/...?start=0&limit=20</self>
</links>
</result>
|
view
View a specified section completion object for a particular user
| Path | GET https://api.schoology.com/v1/sections/{section_id}/completion/user/{uid}/{id} |
| Content | none |
| Return | An object containing section completion fields JSON {
"uid": 48289,
"total_rules": 2,
"completed_rules": 0,
"percent_complete": 0,
"completed": 0
}
XML <?xml version="1.0" encoding="utf-8" ?>
<result>
<uid>48289</uid>
<total_rules>2</total_rules>
<completed_rules>0</completed_rules>
<percent_complete>0</percent_complete>
<completed>0</completed>
</result>
|