Groups in courses

This section relates specifically to the relationship between groups and courses. Groups can be enrolled into a course either before or after a learner has been added to a group. If a learner is added to a group, they inherit the enrolment of any course the group is enrolled in.

Endpoints

• GET /api/v1/courses/{course}/groups
• POST /api/v1/courses/{course}/groups
• GET /api/v1/courses/{course}/groups/{group}
• POST /api/v1/courses/{course}/groups/{group}/links
• GET /api/v1/courses/{course}/groups/{group}/students
• GET /api/v1/courses/{course}/groups/{group}/teachers

Get groups enrolled in a course

GET /api/v1/courses/{course}/groups

Returns a list of all the groups enrolled in a specific course. The groups are returned sorted by creation date, with the most recently created groups appearing first. Filter groups using the query parameters listed in the table.

Path variables

Query parameters

Responses

Create and enrol a group

POST /api/v1/courses/{course}/groups

Create a new group, and enrol it into a specific course.

Path variables

FormData properties

Responses

Get group in a course

GET /api/v1/courses/{course}/groups/{group}

Get the details of a specific group enrolled in a specific course.

Path variables

Responses

Enrol existing group

POST /api/v1/courses/{course}/groups/{group}/links

Enrol an existing group into an existing course.

Path variables

Query parameters

Responses

Get learners in a group

GET /api/v1/courses/{course}/groups/{group}/students

Returns a list of all of the learners enrolled into a specific course via a specific group.

Path variables

Query parameters

Responses

Get trainers in a group

GET /api/v1/courses/{course}/groups/{group}/teachers

Returns a list of all of the trainers enrolled into a specific course via a specific group.

Path variables

Query parameters

Responses