Ir al contenido

Actividades ​

Calendario de actividades de un grupo (clases, guardias, prácticas).

Lista las actividades de un grupo ​

GET /turmas/{turmaId}/atividades

Acceso: Exige la capacidad LER sobre grupo (params.turmaId). Estado de éxito: 200.

Parámetros de ruta

ParámetroTipoObligatorioRestriccionesDescripción
turmaIdstring (uuid)síId del grupo.

Parámetros de consulta

ParámetroTipoObligatorioRestriccionesDescripción
buscastringnoa 100 caracteresTexto para buscar (nombre o correo, según la ruta).
limiteintegerno1…200; por defecto: 50Cuántos elementos por página (1 a 200; el valor predeterminado varía por ruta, en general 50).
deslocamentointegerno0…100000; por defecto: 0Cuántos elementos saltar, para paginar (hasta 100000).
inativos"true" | "false"nopor defecto: "false"true incluye también los registros inactivos.
destringno^\d{4}-\d{2}-\d{2}$Fecha inicial de la ventana (AAAA-MM-DD), inclusive.
atestringno^\d{4}-\d{2}-\d{2}$Fecha final de la ventana (AAAA-MM-DD), inclusive.

Respuesta

lista de AtividadeDto (+ total)

CampoTipoObligatorioRestriccionesDescripción
idstring (uuid)sí
turmaIdstring (uuid)sí
dataDatasí
horaInicioHora o nulosí
horaFimHora o nulosí
atividadeProfissionalIdstring (uuid) o nulosí
atividadeProfissionalNomestring o nulosíNombre del elemento del catálogo (para listas y pantallas que no cargan el catálogo).
descricaostring o nulosí
observacoesstring o nulosí
localstring o nulosí
obrigatoriabooleansí
canceladabooleansí
cercaAtivabooleansí
cercaRaioMinteger o nulosí

En caso de error: modelo ErroApi.

Ejemplo

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

Crea una actividad en el grupo ​

POST /turmas/{turmaId}/atividades

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

Parámetros de ruta

ParámetroTipoObligatorioRestriccionesDescripción
turmaIdstring (uuid)síId del grupo.

Cuerpo de la solicitud (AtividadeCriar)

CampoTipoObligatorioRestriccionesDescripción
dataDatasí
atividadeProfissionalIdstring (uuid) o nulono
horaInicioHora o nulono
horaFimHora o nulono
descricaostring o nulonoa 2000 caracteres
observacoesstring o nulonoa 5000 caracteres
localstring o nulonoa 500 caracteres
obrigatoriabooleanno
canceladabooleanno
cercaAtivabooleanno
cercaRaioMinteger o nulono10…5000
latnumber o nulono-90…90
lngnumber o nulono-180…180

Respuesta

AtividadeDto

CampoTipoObligatorioRestriccionesDescripción
idstring (uuid)sí
turmaIdstring (uuid)sí
dataDatasí
horaInicioHora o nulosí
horaFimHora o nulosí
atividadeProfissionalIdstring (uuid) o nulosí
atividadeProfissionalNomestring o nulosíNombre del elemento del catálogo (para listas y pantallas que no cargan el catálogo).
descricaostring o nulosí
observacoesstring o nulosí
localstring o nulosí
obrigatoriabooleansí
canceladabooleansí
cercaAtivabooleansí
cercaRaioMinteger o nulosí

En caso de error: modelo ErroApi.

Ejemplo

bash
curl -X POST "$API/turmas/{turmaId}/atividades" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{"data":"2026-03-10"}'

Lee una actividad ​

GET /turmas/{turmaId}/atividades/{atividadeId}

Acceso: Exige la capacidad LER sobre grupo (params.turmaId). Estado de éxito: 200.

Parámetros de ruta

ParámetroTipoObligatorioRestriccionesDescripción
atividadeIdstring (uuid)síId de la actividad.
turmaIdstring (uuid)síId del grupo.

Respuesta

AtividadeDto

CampoTipoObligatorioRestriccionesDescripción
idstring (uuid)sí
turmaIdstring (uuid)sí
dataDatasí
horaInicioHora o nulosí
horaFimHora o nulosí
atividadeProfissionalIdstring (uuid) o nulosí
atividadeProfissionalNomestring o nulosíNombre del elemento del catálogo (para listas y pantallas que no cargan el catálogo).
descricaostring o nulosí
observacoesstring o nulosí
localstring o nulosí
obrigatoriabooleansí
canceladabooleansí
cercaAtivabooleansí
cercaRaioMinteger o nulosí

En caso de error: modelo ErroApi.

Ejemplo

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

Elimina una actividad (si no tiene asistencia) ​

DELETE /turmas/{turmaId}/atividades/{atividadeId}

Solo es posible si la actividad aún no tiene asistencia; de lo contrario, cancélela en vez de eliminarla.

Acceso: Exige la capacidad CADASTRAR sobre grupo (params.turmaId). Estado de éxito: 204.

Parámetros de ruta

ParámetroTipoObligatorioRestriccionesDescripción
atividadeIdstring (uuid)síId de la actividad.
turmaIdstring (uuid)síId del grupo.

Respuesta

Sin cuerpo en la respuesta.

En caso de error: modelo ErroApi.

Ejemplo

bash
curl -X DELETE "$API/turmas/{turmaId}/atividades/{atividadeId}" -H "Authorization: Bearer $TOKEN"

Actualiza una actividad ​

PATCH /turmas/{turmaId}/atividades/{atividadeId}

Acceso: Exige la capacidad CADASTRAR sobre grupo (params.turmaId). Estado de éxito: 200.

Parámetros de ruta

ParámetroTipoObligatorioRestriccionesDescripción
atividadeIdstring (uuid)síId de la actividad.
turmaIdstring (uuid)síId del grupo.

Cuerpo de la solicitud (AtividadeAtualizar)

CampoTipoObligatorioRestriccionesDescripción
dataDatano
atividadeProfissionalIdstring (uuid) o nulono
horaInicioHora o nulono
horaFimHora o nulono
descricaostring o nulonoa 2000 caracteres
observacoesstring o nulonoa 5000 caracteres
localstring o nulonoa 500 caracteres
obrigatoriabooleanno
canceladabooleanno
cercaAtivabooleanno
cercaRaioMinteger o nulono10…5000
latnumber o nulono-90…90
lngnumber o nulono-180…180

Respuesta

AtividadeDto

CampoTipoObligatorioRestriccionesDescripción
idstring (uuid)sí
turmaIdstring (uuid)sí
dataDatasí
horaInicioHora o nulosí
horaFimHora o nulosí
atividadeProfissionalIdstring (uuid) o nulosí
atividadeProfissionalNomestring o nulosíNombre del elemento del catálogo (para listas y pantallas que no cargan el catálogo).
descricaostring o nulosí
observacoesstring o nulosí
localstring o nulosí
obrigatoriabooleansí
canceladabooleansí
cercaAtivabooleansí
cercaRaioMinteger o nulosí

En caso de error: modelo ErroApi.

Ejemplo

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

contato@presente.app.br