Ir para o conteúdo

Meu início ​

Visões da própria pessoa: início, painel de atividades e estatísticas de presença.

Lista as atividades da pessoa como aluna ​

GET /me/atividades

Acesso: Qualquer pessoa autenticada. Status de sucesso: 200.

Parâmetros de consulta

ParâmetroTipoObrigatórioRestriçõesDescrição
destringnão^\d{4}-\d{2}-\d{2}$Data inicial da janela (AAAA-MM-DD), inclusive.
atestringnão^\d{4}-\d{2}-\d{2}$Data final da janela (AAAA-MM-DD), inclusive.
limiteintegernão1…200; padrão: 100Quantos itens por página (1 a 200; o padrão varia por rota, em geral 50).

Resposta

MinhasAtividades

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

Em caso de erro: modelo ErroApi.

Exemplo

bash
curl -X GET "$API/me/atividades" -H "Authorization: Bearer $TOKEN"

Início da pessoa (aluno, avaliador e gestão) ​

GET /me/cockpit

Acesso: Qualquer pessoa autenticada. Status de sucesso: 200.

Parâmetros de consulta

ParâmetroTipoObrigatórioRestriçõesDescrição
instituicaoIdstring (uuid)nãoId da instituição.

Resposta

Cockpit

CampoTipoObrigatórioRestriçõesDescrição
alunoCockpitAluno ou nulosim
avaliadorCockpitAvaliador ou nulosim
gestaoCockpitGestao ou nulosim

Em caso de erro: modelo ErroApi.

Exemplo

bash
curl -X GET "$API/me/cockpit" -H "Authorization: Bearer $TOKEN"

Estatísticas de presença da pessoa ​

GET /me/estatisticas

Acesso: Qualquer pessoa autenticada. Status de sucesso: 200.

Parâmetros de consulta

ParâmetroTipoObrigatórioRestriçõesDescrição
destringnão^\d{4}-\d{2}-\d{2}$Data inicial da janela (AAAA-MM-DD), inclusive.
atestringnão^\d{4}-\d{2}-\d{2}$Data final da janela (AAAA-MM-DD), inclusive.
turmaIdstring (uuid)nãoId da turma.
turmaAtiva"true" | "false"nãopadrão: "true"true devolve só turmas ativas.

Resposta

Estatisticas

CampoTipoObrigatórioRestriçõesDescrição
turmaslista de EstatisticaTurmasim

Em caso de erro: modelo ErroApi.

Exemplo

bash
curl -X GET "$API/me/estatisticas" -H "Authorization: Bearer $TOKEN"

Painel de atividades da pessoa, com filtros ​

GET /me/painel

Acesso: Qualquer pessoa autenticada. Status de sucesso: 200.

Parâmetros de consulta

ParâmetroTipoObrigatórioRestriçõesDescrição
destringnão^\d{4}-\d{2}-\d{2}$Data inicial da janela (AAAA-MM-DD), inclusive.
atestringnão^\d{4}-\d{2}-\d{2}$Data final da janela (AAAA-MM-DD), inclusive.
instituicaoIdstring (uuid)nãoId da instituição.
disciplinaIdstring (uuid)nãoId da disciplina.
turmaIdstring (uuid)nãoId da turma.
alunoIdstring (uuid)nãoId do aluno.
estadosstringnãoEstados do pedido de presença, separados por vírgula.
turmaAtiva"true" | "false"nãopadrão: "true"true devolve só turmas ativas.
limiteintegernão1…500; padrão: 300Quantos itens por página (1 a 200; o padrão varia por rota, em geral 50).

Resposta

Painel

CampoTipoObrigatórioRestriçõesDescrição
itemslista de PainelItemsim
truncadobooleansimHavia mais linhas do que o limite.
opcoesobjectsimOpções dos filtros: tudo o que a pessoa enxerga, independente dos filtros ativos.
opcoes.instituicoeslista de objectsim
opcoes.instituicoes[].idstring (uuid)sim
opcoes.instituicoes[].siglastringsim
opcoes.instituicoes[].nomestringsim
opcoes.disciplinaslista de objectsim
opcoes.disciplinas[].idstring (uuid)sim
opcoes.disciplinas[].siglastringsim
opcoes.disciplinas[].nomestringsim
opcoes.disciplinas[].instituicaoIdstring (uuid)sim
opcoes.turmaslista de objectsim
opcoes.turmas[].idstring (uuid)sim

Em caso de erro: modelo ErroApi.

Exemplo

bash
curl -X GET "$API/me/painel" -H "Authorization: Bearer $TOKEN"

contato@presente.app.br