Mi inicio
Vistas de la propia persona: inicio, panel de actividades y estadísticas de asistencia.
Lista las actividades de la persona como alumna
GET /me/atividades
Acceso: Cualquier persona autenticada. Estado de éxito: 200.
Parámetros de consulta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
de | string | no | ^\d{4}-\d{2}-\d{2}$ | Fecha inicial de la ventana (AAAA-MM-DD), inclusive. |
ate | string | no | ^\d{4}-\d{2}-\d{2}$ | Fecha final de la ventana (AAAA-MM-DD), inclusive. |
limite | integer | no | 1…200; por defecto: 100 | Cuántos elementos por página (1 a 200; el valor predeterminado varía por ruta, en general 50). |
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
items | lista de MinhaAtividadeDto | sí |
En caso de error: modelo ErroApi.
Ejemplo
bash
curl -X GET "$API/me/atividades" -H "Authorization: Bearer $TOKEN"Inicio de la persona (alumno, evaluador y gestión)
GET /me/cockpit
Acceso: Cualquier persona autenticada. Estado de éxito: 200.
Parámetros de consulta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
instituicaoId | string (uuid) | no | Id de la institución. |
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
aluno | CockpitAluno o nulo | sí | ||
avaliador | CockpitAvaliador o nulo | sí | ||
gestao | CockpitGestao o nulo | sí |
En caso de error: modelo ErroApi.
Ejemplo
bash
curl -X GET "$API/me/cockpit" -H "Authorization: Bearer $TOKEN"Estadísticas de asistencia de la persona
GET /me/estatisticas
Acceso: Cualquier persona autenticada. Estado de éxito: 200.
Parámetros de consulta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
de | string | no | ^\d{4}-\d{2}-\d{2}$ | Fecha inicial de la ventana (AAAA-MM-DD), inclusive. |
ate | string | no | ^\d{4}-\d{2}-\d{2}$ | Fecha final de la ventana (AAAA-MM-DD), inclusive. |
turmaId | string (uuid) | no | Id del grupo. | |
turmaAtiva | "true" | "false" | no | por defecto: "true" | true devuelve solo grupos activos. |
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
turmas | lista de EstatisticaTurma | sí |
En caso de error: modelo ErroApi.
Ejemplo
bash
curl -X GET "$API/me/estatisticas" -H "Authorization: Bearer $TOKEN"Panel de actividades de la persona, con filtros
GET /me/painel
Acceso: Cualquier persona autenticada. Estado de éxito: 200.
Parámetros de consulta
| Parámetro | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
de | string | no | ^\d{4}-\d{2}-\d{2}$ | Fecha inicial de la ventana (AAAA-MM-DD), inclusive. |
ate | string | no | ^\d{4}-\d{2}-\d{2}$ | Fecha final de la ventana (AAAA-MM-DD), inclusive. |
instituicaoId | string (uuid) | no | Id de la institución. | |
disciplinaId | string (uuid) | no | Id de la asignatura. | |
turmaId | string (uuid) | no | Id del grupo. | |
alunoId | string (uuid) | no | Id del alumno. | |
estados | string | no | Estados del pedido de asistencia, separados por coma. | |
turmaAtiva | "true" | "false" | no | por defecto: "true" | true devuelve solo grupos activos. |
limite | integer | no | 1…500; por defecto: 300 | Cuántos elementos por página (1 a 200; el valor predeterminado varía por ruta, en general 50). |
Respuesta
| Campo | Tipo | Obligatorio | Restricciones | Descripción |
|---|---|---|---|---|
items | lista de PainelItem | sí | ||
truncado | boolean | sí | Había más filas que el límite. | |
opcoes | object | sí | Opciones de los filtros: todo lo que la persona ve, independientemente de los filtros activos. | |
opcoes.instituicoes | lista de object | sí | ||
opcoes.instituicoes[].id | string (uuid) | sí | ||
opcoes.instituicoes[].sigla | string | sí | ||
opcoes.instituicoes[].nome | string | sí | ||
opcoes.disciplinas | lista de object | sí | ||
opcoes.disciplinas[].id | string (uuid) | sí | ||
opcoes.disciplinas[].sigla | string | sí | ||
opcoes.disciplinas[].nome | string | sí | ||
opcoes.disciplinas[].instituicaoId | string (uuid) | sí | ||
opcoes.turmas | lista de object | sí | ||
opcoes.turmas[].id | string (uuid) | sí |
En caso de error: modelo ErroApi.
Ejemplo
bash
curl -X GET "$API/me/painel" -H "Authorization: Bearer $TOKEN"