Saltar para o conteúdo principal

​
Cursos

Um curso representa um programa académico — uma licenciatura, diploma, curso profissional ou programa de formação. Liga módulos num currículo estruturado e fornece o contexto académico para os certificados.

​
O objeto curso

{
  "uuid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "code": "BCS-2024",
  "name": "Bachelor of Computer Science",
  "description": "A 4-year undergraduate program in computer science.",
  "workload_hours": 3200,
  "area": "Technology",
  "version": "2024.1",
  "status": "active",
  "institution": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Federal University of Technology"
  },
  "organization": null,
  "created_at": "2024-01-15T10:00:00.000000Z"
}
CampoTipoDescrição
uuidstringIdentificador único
codestringCódigo interno do curso
namestringNome do curso (máx. 255 caracteres)
descriptionstringDescrição do programa
workload_hoursintegerTotal de horas do programa
areastringÁrea do conhecimento (ex.: Tecnologia, Saúde)
versionstringVersão do currículo
statusenumdraft, active, archived
institutionobjectInstituição pai
organizationobject|nullSubunidade opcional (faculdade/departamento)

​
Listar cursos

GET /courses

curl "https://api.dokstamp.eu/courses?where[status]=active&sort[column]=name" \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Accept: application/json" \
  -H "X-Tenant: {TENANT}"

​
Criar um curso

POST /courses
ParâmetroTipoObrigatórioDescrição
namestringSimNome do curso
institution_uuidstringSimUUID da instituição pai
codestringNãoCódigo interno
descriptionstringNãoDescrição do programa
workload_hoursintegerNãoTotal de horas do programa
areastringNãoÁrea do conhecimento
versionstringNãoVersão do currículo
statusenumNãodraft (padrão), active, archived
organization_uuidstringNãoUUID da subunidade (faculdade/departamento)
curl -X POST https://api.dokstamp.eu/courses \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Tenant: {TENANT}" \
  -d '{
    "name": "Bachelor of Computer Science",
    "code": "BCS-2024",
    "institution_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "workload_hours": 3200,
    "area": "Technology",
    "version": "2024.1",
    "status": "active"
  }'
Resposta 201: 
{
  "data": {
    "uuid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "name": "Bachelor of Computer Science",
    "status": "active",
    ...
  }
}

​
Obter, atualizar, eliminar

GET    /courses/{uuid}
PATCH  /courses/{uuid}
PUT    /courses/{uuid}
DELETE /courses/{uuid}
DELETE /courses/batch/destroy

​
Transições de estado

EstadoSignificado
draftO curso está a ser configurado — ainda não aceita matrículas
activeO curso está ativo — os certificados podem ser emitidos
archivedO curso já não é oferecido — os registos históricos são mantidos

​
Próximos passos para cursos

Após criar um curso:
  1. Associar módulos → Módulos do Curso
  2. Criar grupos de módulos → Grupos de Módulos
  3. Criar turmas → Turmas
  4. Emitir certificados → Certificados