Class attendance
A class's attendance grid (students × activities).
The class attendance grid
GET /turmas/{turmaId}/frequencia
Access: Requires the capability LER over class (params.turmaId). Success status: 200.
Path parameters
| Parameter | Type | Required | Constraints | Description |
|---|---|---|---|---|
turmaId | string (uuid) | yes | Class id. |
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. |
Response
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
turma | object | yes | ||
turma.id | string (uuid) | yes | ||
turma.nome | string | yes | ||
hoje | Data | yes | Today's date in the institution's time zone (to highlight the “today” column). | |
de | Data | yes | ||
ate | Data | yes | ||
atividades | list of object | yes | Activities in the window, by start date and time. | |
atividades[].id | string (uuid) | yes | ||
atividades[].data | Data | yes | ||
atividades[].horaInicio | string or null | yes | ||
atividades[].horaFim | string or null | yes | ||
atividades[].descricao | string or null | yes | ||
atividades[].obrigatoria | boolean | yes | ||
atividades[].cancelada | boolean | yes |
On error: ErroApi model.
Example
bash
curl -X GET "$API/turmas/{turmaId}/frequencia" -H "Authorization: Bearer $TOKEN"