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.

​
Módulos

Módulos são as disciplinas, unidades curriculares ou unidades individuais que compõem um curso. Crie os módulos ao nível da instituição e, em seguida, associe-os a um ou mais cursos.

​
O objeto módulo

{
  "uuid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "code": "CS101",
  "name": "Introduction to Programming",
  "description": "Fundamentals of programming using Python.",
  "syllabus": "Variables, control flow, functions, OOP basics.",
  "workload": 80,
  "credits": 4,
  "modality": "hybrid",
  "level": "undergraduate",
  "is_active": true,
  "is_required": true,
  "institution": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Federal University of Technology"
  }
}
CampoTipoDescrição
uuidstringIdentificador único
codestringCódigo do módulo (único por instituição, máx. 20 caracteres)
namestringNome do módulo (máx. 150 caracteres)
descriptionstringDescrição resumida
syllabusstringConteúdo completo da ementa
workloadintegerCarga horária total (sem sinal)
creditsintegerCréditos académicos (sem sinal)
modalityenumin_person, online, hybrid
levelenumundergraduate, graduate, technical, open
is_activebooleanIndica se o módulo está ativo
is_requiredbooleanIndica se o módulo é obrigatório no curso

​
Listar módulos

GET /modules

curl "https://api.dokstamp.com/modules?where[level]=undergraduate&sort[column]=name&sort[order]=asc" \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Accept: application/json" \
  -H "X-Tenant: {TENANT}"

​
Criar um módulo

POST /modules
ParâmetroTipoObrigatórioDescrição
namestringSimNome do módulo
institution_uuidstringSimUUID da instituição pai
codestringNãoCódigo do módulo (único por instituição)
descriptionstringNãoDescrição resumida
syllabusstringNãoEmenta completa
workloadintegerNãoTotal de horas de contacto
creditsintegerNãoCréditos académicos
modalityenumNãoin_person, online, hybrid
levelenumNãoundergraduate, graduate, technical, open
is_activebooleanNãoPadrão: true
is_requiredbooleanNãoPadrão: false
curl -X POST https://api.dokstamp.com/modules \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Tenant: {TENANT}" \
  -d '{
    "name": "Introduction to Programming",
    "code": "CS101",
    "institution_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "workload": 80,
    "credits": 4,
    "modality": "hybrid",
    "level": "undergraduate",
    "is_active": true,
    "is_required": true
  }'

​
Obter, atualizar, eliminar

GET    /modules/{uuid}
PATCH  /modules/{uuid}
PUT    /modules/{uuid}
DELETE /modules/{uuid}
DELETE /modules/batch/destroy
Após criar os módulos, associe-os a um curso utilizando POST /courses/{uuid}/attach/modules. Consulte Módulos do Curso.