Atividades
Calendário de atividades de uma turma (aulas, plantões, práticas).
Lista as atividades de uma turma
GET /turmas/{turmaId}/atividades
Acesso: Exige a capacidade LER sobre turma (params.turmaId). Status de sucesso: 200.
Parâmetros de caminho
| Parâmetro | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
turmaId | string (uuid) | sim | Id da turma. |
Parâmetros de consulta
| Parâmetro | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
busca | string | não | a 100 caracteres | Texto para buscar (nome ou e-mail, conforme a rota). |
limite | integer | não | 1…200; padrão: 50 | Quantos itens por página (1 a 200; o padrão varia por rota, em geral 50). |
deslocamento | integer | não | 0…100000; padrão: 0 | Quantos itens pular, para paginar (até 100000). |
inativos | "true" | "false" | não | padrão: "false" | true inclui também os registros inativos. |
de | string | não | ^\d{4}-\d{2}-\d{2}$ | Data inicial da janela (AAAA-MM-DD), inclusive. |
ate | string | não | ^\d{4}-\d{2}-\d{2}$ | Data final da janela (AAAA-MM-DD), inclusive. |
Resposta
lista de AtividadeDto (+ total)
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
id | string (uuid) | sim | ||
turmaId | string (uuid) | sim | ||
data | Data | sim | ||
horaInicio | Hora ou nulo | sim | ||
horaFim | Hora ou nulo | sim | ||
atividadeProfissionalId | string (uuid) ou nulo | sim | ||
atividadeProfissionalNome | string ou nulo | sim | Nome do item do catálogo (para listas e telas que não carregam o catálogo). | |
descricao | string ou nulo | sim | ||
observacoes | string ou nulo | sim | ||
local | string ou nulo | sim | ||
obrigatoria | boolean | sim | ||
cancelada | boolean | sim | ||
cercaAtiva | boolean | sim | ||
cercaRaioM | integer ou nulo | sim |
Em caso de erro: modelo ErroApi.
Exemplo
curl -X GET "$API/turmas/{turmaId}/atividades" -H "Authorization: Bearer $TOKEN"Cria uma atividade na turma
POST /turmas/{turmaId}/atividades
Acesso: Exige a capacidade CADASTRAR sobre turma (params.turmaId). Status de sucesso: 201.
Parâmetros de caminho
| Parâmetro | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
turmaId | string (uuid) | sim | Id da turma. |
Corpo da requisição (AtividadeCriar)
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
data | Data | sim | ||
atividadeProfissionalId | string (uuid) ou nulo | não | ||
horaInicio | Hora ou nulo | não | ||
horaFim | Hora ou nulo | não | ||
descricao | string ou nulo | não | a 2000 caracteres | |
observacoes | string ou nulo | não | a 5000 caracteres | |
local | string ou nulo | não | a 500 caracteres | |
obrigatoria | boolean | não | ||
cancelada | boolean | não | ||
cercaAtiva | boolean | não | ||
cercaRaioM | integer ou nulo | não | 10…5000 | |
lat | number ou nulo | não | -90…90 | |
lng | number ou nulo | não | -180…180 |
Resposta
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
id | string (uuid) | sim | ||
turmaId | string (uuid) | sim | ||
data | Data | sim | ||
horaInicio | Hora ou nulo | sim | ||
horaFim | Hora ou nulo | sim | ||
atividadeProfissionalId | string (uuid) ou nulo | sim | ||
atividadeProfissionalNome | string ou nulo | sim | Nome do item do catálogo (para listas e telas que não carregam o catálogo). | |
descricao | string ou nulo | sim | ||
observacoes | string ou nulo | sim | ||
local | string ou nulo | sim | ||
obrigatoria | boolean | sim | ||
cancelada | boolean | sim | ||
cercaAtiva | boolean | sim | ||
cercaRaioM | integer ou nulo | sim |
Em caso de erro: modelo ErroApi.
Exemplo
curl -X POST "$API/turmas/{turmaId}/atividades" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{"data":"2026-03-10"}'Lê uma atividade
GET /turmas/{turmaId}/atividades/{atividadeId}
Acesso: Exige a capacidade LER sobre turma (params.turmaId). Status de sucesso: 200.
Parâmetros de caminho
| Parâmetro | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
atividadeId | string (uuid) | sim | Id da atividade. | |
turmaId | string (uuid) | sim | Id da turma. |
Resposta
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
id | string (uuid) | sim | ||
turmaId | string (uuid) | sim | ||
data | Data | sim | ||
horaInicio | Hora ou nulo | sim | ||
horaFim | Hora ou nulo | sim | ||
atividadeProfissionalId | string (uuid) ou nulo | sim | ||
atividadeProfissionalNome | string ou nulo | sim | Nome do item do catálogo (para listas e telas que não carregam o catálogo). | |
descricao | string ou nulo | sim | ||
observacoes | string ou nulo | sim | ||
local | string ou nulo | sim | ||
obrigatoria | boolean | sim | ||
cancelada | boolean | sim | ||
cercaAtiva | boolean | sim | ||
cercaRaioM | integer ou nulo | sim |
Em caso de erro: modelo ErroApi.
Exemplo
curl -X GET "$API/turmas/{turmaId}/atividades/{atividadeId}" -H "Authorization: Bearer $TOKEN"Remove uma atividade (se não tiver presença)
DELETE /turmas/{turmaId}/atividades/{atividadeId}
Só é possível se a atividade ainda não tiver presença; caso contrário, cancele-a em vez de removê-la.
Acesso: Exige a capacidade CADASTRAR sobre turma (params.turmaId). Status de sucesso: 204.
Parâmetros de caminho
| Parâmetro | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
atividadeId | string (uuid) | sim | Id da atividade. | |
turmaId | string (uuid) | sim | Id da turma. |
Resposta
Sem corpo na resposta.
Em caso de erro: modelo ErroApi.
Exemplo
curl -X DELETE "$API/turmas/{turmaId}/atividades/{atividadeId}" -H "Authorization: Bearer $TOKEN"Atualiza uma atividade
PATCH /turmas/{turmaId}/atividades/{atividadeId}
Acesso: Exige a capacidade CADASTRAR sobre turma (params.turmaId). Status de sucesso: 200.
Parâmetros de caminho
| Parâmetro | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
atividadeId | string (uuid) | sim | Id da atividade. | |
turmaId | string (uuid) | sim | Id da turma. |
Corpo da requisição (AtividadeAtualizar)
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
data | Data | não | ||
atividadeProfissionalId | string (uuid) ou nulo | não | ||
horaInicio | Hora ou nulo | não | ||
horaFim | Hora ou nulo | não | ||
descricao | string ou nulo | não | a 2000 caracteres | |
observacoes | string ou nulo | não | a 5000 caracteres | |
local | string ou nulo | não | a 500 caracteres | |
obrigatoria | boolean | não | ||
cancelada | boolean | não | ||
cercaAtiva | boolean | não | ||
cercaRaioM | integer ou nulo | não | 10…5000 | |
lat | number ou nulo | não | -90…90 | |
lng | number ou nulo | não | -180…180 |
Resposta
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
id | string (uuid) | sim | ||
turmaId | string (uuid) | sim | ||
data | Data | sim | ||
horaInicio | Hora ou nulo | sim | ||
horaFim | Hora ou nulo | sim | ||
atividadeProfissionalId | string (uuid) ou nulo | sim | ||
atividadeProfissionalNome | string ou nulo | sim | Nome do item do catálogo (para listas e telas que não carregam o catálogo). | |
descricao | string ou nulo | sim | ||
observacoes | string ou nulo | sim | ||
local | string ou nulo | sim | ||
obrigatoria | boolean | sim | ||
cancelada | boolean | sim | ||
cercaAtiva | boolean | sim | ||
cercaRaioM | integer ou nulo | sim |
Em caso de erro: modelo ErroApi.
Exemplo
curl -X PATCH "$API/turmas/{turmaId}/atividades/{atividadeId}" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{}'