My home
Views for the signed-in person: home, activity panel and attendance statistics.
List the person's activities as a student
GET /me/atividades
Access: Any signed-in person. Success status: 200.
Query parameters
| Parameter | Type | Required | Constraints | Description |
|---|---|---|---|---|
de | string | no | ^\d{4}-\d{2}-\d{2}$ | Window start date (YYYY-MM-DD), inclusive. |
ate | string | no | ^\d{4}-\d{2}-\d{2}$ | Window end date (YYYY-MM-DD), inclusive. |
limite | integer | no | 1…200; default: 100 | How many items per page (1 to 200; the default varies by route, usually 50). |
Response
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
items | list of MinhaAtividadeDto | yes |
On error: ErroApi model.
Example
bash
curl -X GET "$API/me/atividades" -H "Authorization: Bearer $TOKEN"The person's home (student, assessor and management)
GET /me/cockpit
Access: Any signed-in person. Success status: 200.
Query parameters
| Parameter | Type | Required | Constraints | Description |
|---|---|---|---|---|
instituicaoId | string (uuid) | no | Institution id. |
Response
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
aluno | CockpitAluno or null | yes | ||
avaliador | CockpitAvaliador or null | yes | ||
gestao | CockpitGestao or null | yes |
On error: ErroApi model.
Example
bash
curl -X GET "$API/me/cockpit" -H "Authorization: Bearer $TOKEN"The person's attendance statistics
GET /me/estatisticas
Access: Any signed-in person. Success status: 200.
Query parameters
| Parameter | Type | Required | Constraints | Description |
|---|---|---|---|---|
de | string | no | ^\d{4}-\d{2}-\d{2}$ | Window start date (YYYY-MM-DD), inclusive. |
ate | string | no | ^\d{4}-\d{2}-\d{2}$ | Window end date (YYYY-MM-DD), inclusive. |
turmaId | string (uuid) | no | Class id. | |
turmaAtiva | "true" | "false" | no | default: "true" | true returns active classes only. |
Response
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
turmas | list of EstatisticaTurma | yes |
On error: ErroApi model.
Example
bash
curl -X GET "$API/me/estatisticas" -H "Authorization: Bearer $TOKEN"The person's activity panel, with filters
GET /me/painel
Access: Any signed-in person. Success status: 200.
Query parameters
| Parameter | Type | Required | Constraints | Description |
|---|---|---|---|---|
de | string | no | ^\d{4}-\d{2}-\d{2}$ | Window start date (YYYY-MM-DD), inclusive. |
ate | string | no | ^\d{4}-\d{2}-\d{2}$ | Window end date (YYYY-MM-DD), inclusive. |
instituicaoId | string (uuid) | no | Institution id. | |
disciplinaId | string (uuid) | no | Discipline id. | |
turmaId | string (uuid) | no | Class id. | |
alunoId | string (uuid) | no | Student id. | |
estados | string | no | Attendance request states, comma-separated. | |
turmaAtiva | "true" | "false" | no | default: "true" | true returns active classes only. |
limite | integer | no | 1…500; default: 300 | How many items per page (1 to 200; the default varies by route, usually 50). |
Response
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
items | list of PainelItem | yes | ||
truncado | boolean | yes | There were more rows than the limit. | |
opcoes | object | yes | Filter options: everything the person can see, regardless of the active filters. | |
opcoes.instituicoes | list of object | yes | ||
opcoes.instituicoes[].id | string (uuid) | yes | ||
opcoes.instituicoes[].sigla | string | yes | ||
opcoes.instituicoes[].nome | string | yes | ||
opcoes.disciplinas | list of object | yes | ||
opcoes.disciplinas[].id | string (uuid) | yes | ||
opcoes.disciplinas[].sigla | string | yes | ||
opcoes.disciplinas[].nome | string | yes | ||
opcoes.disciplinas[].instituicaoId | string (uuid) | yes | ||
opcoes.turmas | list of object | yes | ||
opcoes.turmas[].id | string (uuid) | yes |
On error: ErroApi model.
Example
bash
curl -X GET "$API/me/painel" -H "Authorization: Bearer $TOKEN"