Ir para o conteúdo

Presença (avaliação) ​

O que quem avalia faz: fila de pedidos, confirmar ou rejeitar, lote, leitura de QR e versões do relato.

Fila de pedidos pendentes de todas as turmas ​

GET /presencas/pendentes

Acesso: Exige a capacidade AVALIAR, em algum escopo (a resposta traz só o que a pessoa pode ver). Status de sucesso: 200.

Parâmetros de consulta

ParâmetroTipoObrigatórioRestriçõesDescrição
limiteintegernão1…200; padrão: 50Quantos itens por página (1 a 200; o padrão varia por rota, em geral 50).
deslocamentointegernão0…100000; padrão: 0Quantos itens pular, para paginar (até 100000).

Resposta

FilaAvaliacao

CampoTipoObrigatórioRestriçõesDescrição
itemslista de FilaAvaliacaoItemsim
totalintegersim0…

Em caso de erro: modelo ErroApi.

Exemplo

bash
curl -X GET "$API/presencas/pendentes" -H "Authorization: Bearer $TOKEN"

Resolve o QR lido e abre o pedido de presença ​

POST /presencas/qr

Acesso: Qualquer pessoa autenticada. Limite: até 600 chamadas a cada 60 s por origem. Status de sucesso: 200.

Corpo da requisição (QrResolver)

CampoTipoObrigatórioRestriçõesDescrição
tokenstringsim20–2000 caracteres

Resposta

QrResolvido

CampoTipoObrigatórioRestriçõesDescrição
turmaIdstring (uuid)sim
atividadeobjectsim
atividade.idstring (uuid)sim
atividade.dataDatasim
atividade.descricaostring ou nulosim
linhaPresencaLinhasim

Em caso de erro: modelo ErroApi.

Exemplo

bash
curl -X POST "$API/presencas/qr" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{"token":"texto"}'

Confirma ou rejeita a presença de um aluno ​

PUT /turmas/{turmaId}/atividades/{atividadeId}/matriculas/{matriculaId}/presenca

Acesso: Exige a capacidade AVALIAR sobre turma (params.turmaId). Status de sucesso: 200.

Parâmetros de caminho

ParâmetroTipoObrigatórioRestriçõesDescrição
matriculaIdstring (uuid)simId da matrícula.
atividadeIdstring (uuid)simId da atividade.
turmaIdstring (uuid)simId da turma.

Corpo da requisição (AvaliarPresenca)

CampoTipoObrigatórioRestriçõesDescrição
estado"CONFIRMADA" | "REJEITADA"sim
comentariostring ou nulonãoa 2000 caracteres
notaslista de Notanão0–20 itens
nivelSupervisaoNivelSupervisao ou nulonãoAusente = mantém o que havia; nulo = limpa; só vale ao confirmar.

Resposta

PresencaDto

CampoTipoObrigatórioRestriçõesDescrição
idstring (uuid)sim
atividadeIdstring (uuid)sim
matriculaIdstring (uuid)sim
estado"SOLICITADA" | "CONFIRMADA" | "REJEITADA"sim
solicitadaEmstringsim
capturadaEmstring ou nulosim
relatostring ou nulosim
justificativastring ou nulosim
excecoeslista de "FORA_DA_JANELA" | "FORA_DA_CERCA" | "OUTRO_DIA"sim
avaliadaEmstring ou nulosim
comentarioAvaliadorstring ou nulosim
notaslista de NotasimSó a quem avalia a turma. O aluno vê as próprias notas pelo painel, depois que a turma as libera.
nivelSupervisaoNivelSupervisao ou nulonãoNível de supervisão dado pelo último avaliador; nulo = não informado. Só a quem avalia (o aluno o lê na avaliação, depois da liberação).
relatoEditadoEmstring ou nulonãoÚltima edição do relato pelo aluno; nulo = nunca editado. Depois de avaliadaEm = editado depois da avaliação.

Em caso de erro: modelo ErroApi.

Exemplo

bash
curl -X PUT "$API/turmas/{turmaId}/atividades/{atividadeId}/matriculas/{matriculaId}/presenca" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{"estado":"CONFIRMADA"}'

Lista os pedidos de presença de uma atividade ​

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

Acesso: Exige a capacidade AVALIAR sobre turma (params.turmaId). Status de sucesso: 200.

Parâmetros de caminho

ParâmetroTipoObrigatórioRestriçõesDescrição
atividadeIdstring (uuid)simId da atividade.
turmaIdstring (uuid)simId da turma.

Resposta

PresencaLinhas

CampoTipoObrigatórioRestriçõesDescrição
atividadeobjectsim
atividade.idstring (uuid)sim
atividade.turmaIdstring (uuid)sim
atividade.dataDatasim
atividade.descricaostring ou nulosim
itemslista de PresencaLinhasim

Em caso de erro: modelo ErroApi.

Exemplo

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

Versões anteriores do relato de uma presença ​

GET /turmas/{turmaId}/presencas/{presencaId}/relato/versoes

Acesso: Exige a capacidade AVALIAR sobre turma (params.turmaId). Status de sucesso: 200.

Parâmetros de caminho

ParâmetroTipoObrigatórioRestriçõesDescrição
presencaIdstring (uuid)simId do pedido de presença.
turmaIdstring (uuid)simId da turma.

Resposta

RelatoVersoes

CampoTipoObrigatórioRestriçõesDescrição
itemslista de objectsim
items[].idstring (uuid)sim
items[].textostringsim
items[].substituidoEmstringsim

Em caso de erro: modelo ErroApi.

Exemplo

bash
curl -X GET "$API/turmas/{turmaId}/presencas/{presencaId}/relato/versoes" -H "Authorization: Bearer $TOKEN"

Confirma vários pedidos de presença de uma vez ​

POST /turmas/{turmaId}/presencas/confirmar-lote

Acesso: Exige a capacidade AVALIAR sobre turma (params.turmaId). Status de sucesso: 200.

Parâmetros de caminho

ParâmetroTipoObrigatórioRestriçõesDescrição
turmaIdstring (uuid)simId da turma.

Corpo da requisição (ConfirmarLote)

CampoTipoObrigatórioRestriçõesDescrição
idslista de string (uuid)sim1–100 itens

Resposta

ConfirmarLoteResultado

CampoTipoObrigatórioRestriçõesDescrição
itemslista de PresencaDtosim

Em caso de erro: modelo ErroApi.

Exemplo

bash
curl -X POST "$API/turmas/{turmaId}/presencas/confirmar-lote" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{"ids":["0198a000-0000-7000-8000-000000000001"]}'

Fila de pedidos pendentes da turma ​

GET /turmas/{turmaId}/presencas/pendentes

Acesso: Exige a capacidade AVALIAR sobre turma (params.turmaId). Status de sucesso: 200.

Parâmetros de caminho

ParâmetroTipoObrigatórioRestriçõesDescrição
turmaIdstring (uuid)simId da turma.

Resposta

Pendentes

CampoTipoObrigatórioRestriçõesDescrição
itemslista de Pendentesim

Em caso de erro: modelo ErroApi.

Exemplo

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

contato@presente.app.br