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âmetro | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
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. |
limite | integer | não | 1…200; padrão: 100 | Quantos itens por página (1 a 200; o padrão varia por rota, em geral 50). |
Resposta
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
items | lista de MinhaAtividadeDto | sim |
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âmetro | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
instituicaoId | string (uuid) | não | Id da instituição. |
Resposta
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
aluno | CockpitAluno ou nulo | sim | ||
avaliador | CockpitAvaliador ou nulo | sim | ||
gestao | CockpitGestao ou nulo | sim |
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âmetro | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
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. |
turmaId | string (uuid) | não | Id da turma. | |
turmaAtiva | "true" | "false" | não | padrão: "true" | true devolve só turmas ativas. |
Resposta
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
turmas | lista de EstatisticaTurma | sim |
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âmetro | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
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. |
instituicaoId | string (uuid) | não | Id da instituição. | |
disciplinaId | string (uuid) | não | Id da disciplina. | |
turmaId | string (uuid) | não | Id da turma. | |
alunoId | string (uuid) | não | Id do aluno. | |
estados | string | não | Estados do pedido de presença, separados por vírgula. | |
turmaAtiva | "true" | "false" | não | padrão: "true" | true devolve só turmas ativas. |
limite | integer | não | 1…500; padrão: 300 | Quantos itens por página (1 a 200; o padrão varia por rota, em geral 50). |
Resposta
| Campo | Tipo | Obrigatório | Restrições | Descrição |
|---|---|---|---|---|
items | lista de PainelItem | sim | ||
truncado | boolean | sim | Havia mais linhas do que o limite. | |
opcoes | object | sim | Opções dos filtros: tudo o que a pessoa enxerga, independente dos filtros ativos. | |
opcoes.instituicoes | lista de object | sim | ||
opcoes.instituicoes[].id | string (uuid) | sim | ||
opcoes.instituicoes[].sigla | string | sim | ||
opcoes.instituicoes[].nome | string | sim | ||
opcoes.disciplinas | lista de object | sim | ||
opcoes.disciplinas[].id | string (uuid) | sim | ||
opcoes.disciplinas[].sigla | string | sim | ||
opcoes.disciplinas[].nome | string | sim | ||
opcoes.disciplinas[].instituicaoId | string (uuid) | sim | ||
opcoes.turmas | lista de object | sim | ||
opcoes.turmas[].id | string (uuid) | sim |
Em caso de erro: modelo ErroApi.
Exemplo
bash
curl -X GET "$API/me/painel" -H "Authorization: Bearer $TOKEN"