Matrículas
Alumnos matriculados en un grupo.
Lista las matrículas del grupo
GET /turmas/{turmaId}/matriculas
Acceso: Exige la capacidad LER sobre grupo (params.turmaId). Estado de éxito: 200.
Parámetros de ruta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
turmaId | string (uuid) | sí | Id del grupo. |
Parámetros de consulta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
busca | string | no | a 100 caracteres | Texto para buscar (nombre o correo, según la ruta). |
limite | integer | no | 1…200; por defecto: 50 | Cuántos elementos por página (1 a 200; el valor predeterminado varía por ruta, en general 50). |
deslocamento | integer | no | 0…100000; por defecto: 0 | Cuántos elementos saltar, para paginar (hasta 100000). |
inativos | "true" | "false" | no | por defecto: "false" | true incluye también los registros inactivos. |
Respuesta
lista de MatriculaDto (+ total)
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
id | string (uuid) | sí | ||
turmaId | string (uuid) | sí | ||
usuarioId | string (uuid) | sí | ||
ativo | boolean | sí | ||
nome | string | sí | ||
email | string | sí | ||
status | "CONVIDADO" | "ATIVO" | "SUSPENSO" | sí | ||
jaExistia | boolean | no | Solo en la respuesta de crear por correo: el correo ya tenía cuenta y la persona se vinculó a ella. |
En caso de error: modelo ErroApi.
Ejemplo
curl -X GET "$API/turmas/{turmaId}/matriculas" -H "Authorization: Bearer $TOKEN"Matricula a un alumno en el grupo
POST /turmas/{turmaId}/matriculas
Indique usuarioId (alumno ya registrado) o email y nome (cuenta nueva, con invitación por correo).
Acceso: Exige la capacidad CADASTRAR sobre grupo (params.turmaId). Límite: hasta 120 llamadas cada 60 s por origen. Estado de éxito: 201.
Parámetros de ruta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
turmaId | string (uuid) | sí | Id del grupo. |
Cuerpo de la solicitud (MatriculaCriar)
Opción 1
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
usuarioId | string (uuid) | sí |
Opción 2
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
email | sí | |||
nome | string | sí | 1–200 caracteres | |
nationality | string | no | 2–2 caracteres; ^[A-Za-z]{2}$ |
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
id | string (uuid) | sí | ||
turmaId | string (uuid) | sí | ||
usuarioId | string (uuid) | sí | ||
ativo | boolean | sí | ||
nome | string | sí | ||
email | string | sí | ||
status | "CONVIDADO" | "ATIVO" | "SUSPENSO" | sí | ||
jaExistia | boolean | no | Solo en la respuesta de crear por correo: el correo ya tenía cuenta y la persona se vinculó a ella. |
En caso de error: modelo ErroApi.
Ejemplo
curl -X POST "$API/turmas/{turmaId}/matriculas" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{"usuarioId":"0198a000-0000-7000-8000-000000000001"}'Activa o desactiva una matrícula
PATCH /turmas/{turmaId}/matriculas/{matriculaId}
Desactivar la matrícula solo alterna ativo: no se borra nada, y reactivar devuelve al alumno al grupo.
Acceso: Exige la capacidad CADASTRAR sobre grupo (params.turmaId). Estado de éxito: 200.
Parámetros de ruta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
matriculaId | string (uuid) | sí | Id de la matrícula. | |
turmaId | string (uuid) | sí | Id del grupo. |
Cuerpo de la solicitud (MatriculaAtualizar)
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
ativo | boolean | sí |
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
id | string (uuid) | sí | ||
turmaId | string (uuid) | sí | ||
usuarioId | string (uuid) | sí | ||
ativo | boolean | sí | ||
nome | string | sí | ||
email | string | sí | ||
status | "CONVIDADO" | "ATIVO" | "SUSPENSO" | sí | ||
jaExistia | boolean | no | Solo en la respuesta de crear por correo: el correo ya tenía cuenta y la persona se vinculó a ella. |
En caso de error: modelo ErroApi.
Ejemplo
curl -X PATCH "$API/turmas/{turmaId}/matriculas/{matriculaId}" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{"ativo":false}'