Contrato — /enrolments
Status: Implementado
Termos: Matrícula, Plano do Aluno, Curso-Produto, Trilha Pedagógica
Controller: enrolment_api_controller
UC: UC-002 — Inscrições
Endpoints
GET /api/v1/platform/enrolments
GET /api/v1/platform/enrolments?status=active
Authorization: Bearer {wstoken}Query params
| Param | Tipo | Descrição |
|---|---|---|
status |
active|all |
Filtra por status do student_plan. Default all. |
Response 200
{
"enrolments": [
{
"id": 12,
"course_product": {
"id": 5,
"name": "Magistratura Federal 2026",
"logo_url": "https://..."
},
"enrolled_at": "2026-04-20T10:00:00Z",
"student_plan": {
"id": 42,
"status": "active",
"weekly_hours": 35,
"progress_percent": 35
},
"onboarding": {
"completed": true,
"phase_pending": null
}
}
]
}student_plan states
status |
id |
Significado |
|---|---|---|
creating |
null |
Onboarding submetido; handler async em execução |
active |
integer | Plano criado, Aluno em estudo |
failed |
null |
Handler async falhou (T3); inclui error_message |
| (ausente) | — | Onboarding ainda não submetido |
Roteamento Frontend
| Estado da matrícula | Rota Frontend |
|---|---|
| Sem matrícula ativa | Catálogo / “aguardando configuração” |
| Onboarding pendente | Fluxo Onboarding (onboarding.md) |
student_plan.status=creating |
Polling em loop até id aparecer |
student_plan.status=active |
Área do Aluno → Roteiro |
student_plan.status=failed |
Erro com botão “Tentar de novo” |
Erros
| HTTP | error |
Causa |
|---|---|---|
| 401 | unauthorized |
wstoken ausente/inválido |
Polling P1
Referências
- Source:
classes/extensions/platform/controller/enrolment_api_controller.php - onboarding.md
- UC-002