Skip to main content

Module Groups

Module groups let you organize a course’s modules into logical sections — semesters, academic periods, knowledge areas, or any other grouping that reflects your curriculum structure.

The module group object

{
  "uuid": "d4e5f6a7-b8c9-0123-defg-234567890123",
  "name": "1st Semester",
  "order": 1,
  "is_active": true,
  "course": {
    "uuid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "name": "Bachelor of Computer Science"
  }
}

List module groups

GET /courses/{course_uuid}/modules/groups
curl "https://api.dokstamp.eu/courses/c3d4e5f6-a7b8-9012-cdef-123456789012/modules/groups" \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Accept: application/json" \
  -H "X-Tenant: {TENANT}"

Create a module group

POST /courses/{course_uuid}/modules/groups
ParameterTypeRequiredDescription
namestringYesGroup name (e.g., “1st Semester”)
orderintegerNoDisplay order within the course
is_activebooleanNoDefault: true
curl -X POST "https://api.dokstamp.eu/courses/c3d4e5f6-a7b8-9012-cdef-123456789012/modules/groups" \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Tenant: {TENANT}" \
  -d '{
    "name": "1st Semester",
    "order": 1,
    "is_active": true
  }'
After creating groups, assign modules to them using the course_module_group_uuid parameter when attaching modules. See Course Modules.

Get, update, delete

GET    /courses/{course_uuid}/modules/groups/{group_uuid}
PATCH  /courses/{course_uuid}/modules/groups/{group_uuid}
PUT    /courses/{course_uuid}/modules/groups/{group_uuid}
DELETE /courses/{course_uuid}/modules/groups/{group_uuid}