Pular para o conteúdo principal

​
Turmas

Uma turma representa um ingresso ou turma de formandos específica para um curso — por exemplo, “Turma Noturna 2024/1” ou “Turma EAD — Março 2025”. As turmas são opcionais, mas permitem agrupar matrículas e certificados por turma de formatura.

​
O objeto turma

{
  "uuid": "e5f6a7b8-c9d0-1234-efgh-345678901234",
  "code": "BCS-2024-EVE",
  "modality": "hybrid",
  "start_date": "2024-02-01T00:00:00.000000Z",
  "end_date": "2027-12-31T00:00:00.000000Z",
  "course": {
    "uuid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "name": "Bachelor of Computer Science"
  }
}
CampoTipoDescrição
uuidstringIdentificador único
codestringCódigo único da turma
modalityenumpresential, remote, hybrid
start_datedatetimeData de início da turma
end_datedatetimeData de término da turma (formatura prevista)

​
Listar turmas

GET /cohorts

curl "https://api.dokstamp.eu/cohorts?where[course_uuid]=c3d4e5f6-a7b8-9012-cdef-123456789012" \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Accept: application/json" \
  -H "X-Tenant: {TENANT}"

​
Criar uma turma

POST /cohorts
ParâmetroTipoObrigatórioDescrição
course_uuidstringSimUUID do curso pai
codestringSimCódigo único da turma
modalityenumNãopresential, remote, hybrid
start_datedatetimeNãoData de início da turma
end_datedatetimeNãoData prevista de término/formatura
curl -X POST https://api.dokstamp.eu/cohorts \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Tenant: {TENANT}" \
  -d '{
    "course_uuid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "code": "BCS-2024-EVE",
    "modality": "hybrid",
    "start_date": "2024-02-01T00:00:00Z",
    "end_date": "2027-12-31T00:00:00Z"
  }'

​
Obter, atualizar, excluir

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