The Course Roster Object

The Course Roster object represents the roster of a Course. When a new Course is created, an empty Course Roster is created automatically. To add users to the course, PATCH the associated Course Roster.

Since the Course Roster represents a set of properties of a Course object, you cannot create or delete a Course Roster directly.

{
  "id": 1,
  "name": "COS126",
  "period": "S2019",
  "students": [
    "[email protected]",
    "[email protected]"
  ],
  "graders": [
    "[email protected]",
    "[email protected]"
  ],
  "superGraders": [ // subset of graders
    "[email protected]"
  ],
  "courseAdmins": [
    "[email protected]",
    "[email protected]"
  ],
  "inactive_students": [ // no overlap with students
    "[email protected]"
  ],
  "inactive_graders" : [ // no overlap with graders
    "[email protected]"
  ],
  "inactive_courseAdmins" : [ // no overlap with courseAdmins
    "[email protected]"
  ]
}

Attribute

Type

Description

id

integer

ID of the Course associated with this Course Roster.

students

array of strings

A list of active students in the course, represented by their emails.

graders

array of strings

A list of active graders in the course, represented by their emails.

superGraders

array of strings

A list of active graders in the Course who hold "ViewAll" privileges, represented by their emails This privilege entitles these graders to see all submissions for each Assignment of the course. course.superGraders is a subset of course.graders.

courseAdmins

array of strings

A list of active course admins in the course, represented by their emails.

inactive_students

array of strings

A list of inactive students, represented by their emails. Inactive students are users who were previously active students in this course. The only way for a user to leave course.inactive_students is to be re-activated as a student; excluding inactivation, this list is append-only.

inactive_graders

array of strings

A list of inactive graders. Inactive graders are users who were previously active graders in this course. The only way for a user to leave course.inactive_graders is to be re-activated as a grader; excluding inactivation, this list is append-only.

inactive_courseAdmins

array of strings

A list of inactive course admins. Inactive course admins are users who were previously active course admins in this course. The only way for a user to leave course.inactive_courseAdmins is to be re-activated as a course admin; excluding inactivation, this list is append-only.