Saltar para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.dokstamp.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Grupos de Módulos

Os grupos de módulos permitem organizar os módulos de um curso em secções lógicas — semestres, períodos letivos, áreas do conhecimento ou qualquer outro agrupamento que reflita a estrutura do currículo.

​
O objeto grupo de módulos

{
  "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"
  }
}

​
Listar grupos de módulos

GET /courses/{course_uuid}/modules/groups

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

​
Criar um grupo de módulos

POST /courses/{course_uuid}/modules/groups
ParâmetroTipoObrigatórioDescrição
namestringSimNome do grupo (ex.: “1.º Semestre”)
orderintegerNãoOrdem de apresentação dentro do curso
is_activebooleanNãoPadrão: true
curl -X POST "https://api.dokstamp.com/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
  }'
Após criar os grupos, atribua módulos aos mesmos usando o parâmetro course_module_group_uuid ao associar módulos. Consulte Módulos do Curso.

​
Obter, atualizar, eliminar

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}