Grupos

Grupos de una asignatura: alta, período, equipo auxiliar y preparación.

Lista los grupos de una asignatura

GET /disciplinas/{disciplinaId}/turmas

Acceso: Exige la capacidad LER, en algún ámbito (la respuesta trae solo lo que la persona puede ver). Estado de éxito: 200.

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Restricciones	Descripción
`disciplinaId`	`string (uuid)`	sí		Id de la asignatura.

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 TurmaDto (+ total)

Campo	Tipo	Obligatorio
`id`	`string (uuid)`	sí
`disciplinaId`	`string (uuid)`	sí
`instituicaoId`	`string (uuid)`	sí
`nome`	`string`	sí
`ativo`	`boolean`	sí
`endereco`	`string` o `nulo`	sí
`localAtividade`	`string` o `nulo`	sí
`lat`	`number` o `nulo`	sí
`lng`	`number` o `nulo`	sí
`toleranciaAntesMin`	`integer` o `nulo`	sí
`toleranciaDepoisMin`	`integer` o `nulo`	sí
`notasVisiveisEm`	Data o `nulo`	sí
`dataInicio`	Data o `nulo`	sí
`dataFim`	Data o `nulo`	sí

En caso de error: modelo ErroApi.

Ejemplo

bash

curl -X GET "$API/disciplinas/{disciplinaId}/turmas" -H "Authorization: Bearer $TOKEN"

Crea un grupo en la asignatura

POST /disciplinas/{disciplinaId}/turmas

No es idempotente: un grupo no tiene identificador único, así que repetir la llamada crea otro grupo.

Acceso: Exige la capacidad CADASTRAR sobre asignatura (params.disciplinaId). Estado de éxito: 201.

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Restricciones	Descripción
`disciplinaId`	`string (uuid)`	sí		Id de la asignatura.

Cuerpo de la solicitud (TurmaCriar)

Campo	Tipo	Obligatorio	Restricciones
`nome`	`string`	sí	1–200 caracteres
`endereco`	`string` o `nulo`	no	a 500 caracteres
`localAtividade`	`string` o `nulo`	no	a 500 caracteres
`lat`	`number` o `nulo`	no	-90…90
`lng`	`number` o `nulo`	no	-180…180
`toleranciaAntesMin`	`integer` o `nulo`	no	0…720
`toleranciaDepoisMin`	`integer` o `nulo`	no	0…720
`notasVisiveisEm`	Data o `nulo`	no

Respuesta

TurmaDto

Campo	Tipo	Obligatorio
`id`	`string (uuid)`	sí
`disciplinaId`	`string (uuid)`	sí
`instituicaoId`	`string (uuid)`	sí
`nome`	`string`	sí
`ativo`	`boolean`	sí
`endereco`	`string` o `nulo`	sí
`localAtividade`	`string` o `nulo`	sí
`lat`	`number` o `nulo`	sí
`lng`	`number` o `nulo`	sí
`toleranciaAntesMin`	`integer` o `nulo`	sí
`toleranciaDepoisMin`	`integer` o `nulo`	sí
`notasVisiveisEm`	Data o `nulo`	sí
`dataInicio`	Data o `nulo`	sí
`dataFim`	Data o `nulo`	sí

En caso de error: modelo ErroApi.

Ejemplo

bash

curl -X POST "$API/disciplinas/{disciplinaId}/turmas" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{"nome":"texto"}'

Lista los grupos que la persona ve

GET /turmas

Acceso: Exige la capacidad LER, en algún ámbito (la respuesta trae solo lo que la persona puede ver). Estado de éxito: 200.

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.
`disciplinaId`	`string (uuid)`	no		Id de la asignatura.

Respuesta

lista de TurmaDto (+ total)

Campo	Tipo	Obligatorio
`id`	`string (uuid)`	sí
`disciplinaId`	`string (uuid)`	sí
`instituicaoId`	`string (uuid)`	sí
`nome`	`string`	sí
`ativo`	`boolean`	sí
`endereco`	`string` o `nulo`	sí
`localAtividade`	`string` o `nulo`	sí
`lat`	`number` o `nulo`	sí
`lng`	`number` o `nulo`	sí
`toleranciaAntesMin`	`integer` o `nulo`	sí
`toleranciaDepoisMin`	`integer` o `nulo`	sí
`notasVisiveisEm`	Data o `nulo`	sí
`dataInicio`	Data o `nulo`	sí
`dataFim`	Data o `nulo`	sí

En caso de error: modelo ErroApi.

Ejemplo

bash

curl -X GET "$API/turmas" -H "Authorization: Bearer $TOKEN"

Lee un grupo

GET /turmas/{turmaId}

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.

Respuesta

TurmaDto

Campo	Tipo	Obligatorio
`id`	`string (uuid)`	sí
`disciplinaId`	`string (uuid)`	sí
`instituicaoId`	`string (uuid)`	sí
`nome`	`string`	sí
`ativo`	`boolean`	sí
`endereco`	`string` o `nulo`	sí
`localAtividade`	`string` o `nulo`	sí
`lat`	`number` o `nulo`	sí
`lng`	`number` o `nulo`	sí
`toleranciaAntesMin`	`integer` o `nulo`	sí
`toleranciaDepoisMin`	`integer` o `nulo`	sí
`notasVisiveisEm`	Data o `nulo`	sí
`dataInicio`	Data o `nulo`	sí
`dataFim`	Data o `nulo`	sí

En caso de error: modelo ErroApi.

Ejemplo

bash

curl -X GET "$API/turmas/{turmaId}" -H "Authorization: Bearer $TOKEN"

Actualiza un grupo

PATCH /turmas/{turmaId}

Acceso: Exige la capacidad CADASTRAR 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.

Cuerpo de la solicitud (TurmaAtualizar)

Campo	Tipo	Obligatorio	Restricciones
`nome`	`string`	no	1–200 caracteres
`endereco`	`string` o `nulo`	no	a 500 caracteres
`localAtividade`	`string` o `nulo`	no	a 500 caracteres
`lat`	`number` o `nulo`	no	-90…90
`lng`	`number` o `nulo`	no	-180…180
`toleranciaAntesMin`	`integer` o `nulo`	no	0…720
`toleranciaDepoisMin`	`integer` o `nulo`	no	0…720
`notasVisiveisEm`	Data o `nulo`	no
`ativo`	`boolean`	no

Respuesta

TurmaDto

Campo	Tipo	Obligatorio
`id`	`string (uuid)`	sí
`disciplinaId`	`string (uuid)`	sí
`instituicaoId`	`string (uuid)`	sí
`nome`	`string`	sí
`ativo`	`boolean`	sí
`endereco`	`string` o `nulo`	sí
`localAtividade`	`string` o `nulo`	sí
`lat`	`number` o `nulo`	sí
`lng`	`number` o `nulo`	sí
`toleranciaAntesMin`	`integer` o `nulo`	sí
`toleranciaDepoisMin`	`integer` o `nulo`	sí
`notasVisiveisEm`	Data o `nulo`	sí
`dataInicio`	Data o `nulo`	sí
`dataFim`	Data o `nulo`	sí

En caso de error: modelo ErroApi.

Ejemplo

bash

curl -X PATCH "$API/turmas/{turmaId}" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{}'

Lista los auxiliares del grupo

GET /turmas/{turmaId}/auxiliares

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 VinculoItem (+ total)

Campo	Tipo	Obligatorio
`id`	`string (uuid)`	sí
`usuarioId`	`string (uuid)`	sí
`nome`	`string`	sí
`email`	`string`	sí
`papel`	`"ADMIN_PLATAFORMA"` \| `"CURADOR"` \| `"PRECEPTOR"` \| `"COORDENADOR"` \| `"PROFESSOR"` \| `"AUXILIAR"`	sí
`instituicaoId`	`string (uuid)` o `nulo`	sí
`disciplinaId`	`string (uuid)` o `nulo`	sí
`turmaId`	`string (uuid)` o `nulo`	sí
`podeAvaliar`	`boolean`	sí
`podeCadastrar`	`boolean`	sí
`ativo`	`boolean`	sí

En caso de error: modelo ErroApi.

Ejemplo

bash

curl -X GET "$API/turmas/{turmaId}/auxiliares" -H "Authorization: Bearer $TOKEN"

Define el período (inicio y fin) del grupo

PUT /turmas/{turmaId}/periodo

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.

Cuerpo de la solicitud (TurmaPeriodo)

Campo	Tipo	Obligatorio	Restricciones	Descripción
`dataInicio`	Data o `nulo`	sí
`dataFim`	Data o `nulo`	sí

Respuesta

TurmaDto

Campo	Tipo	Obligatorio
`id`	`string (uuid)`	sí
`disciplinaId`	`string (uuid)`	sí
`instituicaoId`	`string (uuid)`	sí
`nome`	`string`	sí
`ativo`	`boolean`	sí
`endereco`	`string` o `nulo`	sí
`localAtividade`	`string` o `nulo`	sí
`lat`	`number` o `nulo`	sí
`lng`	`number` o `nulo`	sí
`toleranciaAntesMin`	`integer` o `nulo`	sí
`toleranciaDepoisMin`	`integer` o `nulo`	sí
`notasVisiveisEm`	Data o `nulo`	sí
`dataInicio`	Data o `nulo`	sí
`dataFim`	Data o `nulo`	sí

En caso de error: modelo ErroApi.

Ejemplo

bash

curl -X PUT "$API/turmas/{turmaId}/periodo" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{"dataInicio":"2026-03-10","dataFim":"2026-03-10"}'

Qué está ya listo en el grupo (conteos)

GET /turmas/{turmaId}/prontidao

Devuelve solo conteos (alumnos con acceso, evaluadores, actividades futuras…), nunca nombres ni correos.

Acceso: Exige la capacidad CADASTRAR 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.

Respuesta

TurmaProntidao

Campo	Tipo	Obligatorio	Restricciones	Descripción
`centro`	`boolean`	sí
`toleranciaPropria`	`boolean`	sí		Tolerancia propia del grupo; `false` = vale el predeterminado.
`atividadesFuturas`	`integer`	sí	0…	Actividades no canceladas de hoy en adelante (en la zona horaria de la institución).
`alunos`	`integer`	sí	0…
`alunosComAcesso`	`integer`	sí	0…	Alumnos que ya aceptaron la invitación (cuenta activa) y pueden registrar asistencia.
`avaliadores`	`integer`	sí	0…	Personas con cuenta activa que pueden confirmar asistencia en este grupo, en cualquier nivel (grupo, asignatura, institución).
`avaliadoresConvidados`	`integer`	sí	0…	Personas que podrán evaluar, pero aún no aceptaron la invitación.

En caso de error: modelo ErroApi.

Ejemplo

bash

curl -X GET "$API/turmas/{turmaId}/prontidao" -H "Authorization: Bearer $TOKEN"

Grupos ​

Lista los grupos de una asignatura ​

Crea un grupo en la asignatura ​

Lista los grupos que la persona ve ​

Lee un grupo ​

Actualiza un grupo ​

Lista los auxiliares del grupo ​

Define el período (inicio y fin) del grupo ​

Qué está ya listo en el grupo (conteos) ​

Grupos

Lista los grupos de una asignatura

Crea un grupo en la asignatura

Lista los grupos que la persona ve

Lee un grupo

Actualiza un grupo

Lista los auxiliares del grupo

Define el período (inicio y fin) del grupo

Qué está ya listo en el grupo (conteos)