Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Crie e faça a gestão de programas académicos. Os cursos são a entidade central que liga instituições, módulos, turmas e certificados.
{
"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"
}
| Campo | Tipo | Descrição |
|---|---|---|
uuid | string | Identificador único |
code | string | Código interno do curso |
name | string | Nome do curso (máx. 255 caracteres) |
description | string | Descrição do programa |
workload_hours | integer | Total de horas do programa |
area | string | Área do conhecimento (ex.: Tecnologia, Saúde) |
version | string | Versão do currículo |
status | enum | draft, active, archived |
institution | object | Instituição pai |
organization | object|null | Subunidade opcional (faculdade/departamento) |
GET /courses
curl "https://api.dokstamp.com/courses?where[status]=active&sort[column]=name" \
-H "Authorization: Bearer {TOKEN}" \
-H "Accept: application/json" \
-H "X-Tenant: {TENANT}"
POST /courses
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome do curso |
institution_uuid | string | Sim | UUID da instituição pai |
code | string | Não | Código interno |
description | string | Não | Descrição do programa |
workload_hours | integer | Não | Total de horas do programa |
area | string | Não | Área do conhecimento |
version | string | Não | Versão do currículo |
status | enum | Não | draft (padrão), active, archived |
organization_uuid | string | Não | UUID da subunidade (faculdade/departamento) |
curl -X POST https://api.dokstamp.com/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"
}'
201:
{
"data": {
"uuid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"name": "Bachelor of Computer Science",
"status": "active",
...
}
}
GET /courses/{uuid}
PATCH /courses/{uuid}
PUT /courses/{uuid}
DELETE /courses/{uuid}
DELETE /courses/batch/destroy
| Estado | Significado |
|---|---|
draft | O curso está a ser configurado — ainda não aceita matrículas |
active | O curso está ativo — os certificados podem ser emitidos |
archived | O curso já não é oferecido — os registos históricos são mantidos |