Assignment Groups API
API for accessing Assignment Group and Assignment information.
List assignment groups AssignmentGroupsController#index
GET /api/v1/courses/:course_id/assignment_groups
Returns the list of assignment groups for the current context. The returned groups are sorted by their position field.
Request Parameters:
-
include[]
- "assignments"
-
Associations to include with the group.
API response field:
-
id
The unique identifier for the assignment group.
-
name
The name of the assignment group.
-
position
- Integer
-
The sorting order of this group in the
groups for this context.
Example Response:
[
{
"position": 7,
"name": "group2",
"id": 1,
"group_weight": 20,
"assignments": [...],
"rules" : {...}
},
{
"position": 10,
"name": "group1",
"id": 2,
"group_weight": 20,
"assignments": [...],
"rules" : {...}
},
{
"position": 12,
"name": "group3",
"id": 3,
"group_weight": 60,
"assignments": [...],
"rules" : {...}
}
]