Consultar frequência e andamento de uma turma

Aceita Classroom.id (hash) ou sigaa_id numérico. frequency_status indica nao_registrada, parcialmente_registrada ou registrada nas entradas publicadas. lessons traz as aulas da turma (criadas pelo calendário e horário no sync das turmas, com start_time e end_time) até ontem, as publicadas pelo SIGAA fora delas e as com situação do aluno, mais recentes primeiro; totals soma as marcações aos totais do SIGAA.

GET /classrooms/{classroom_id}/frequency

Consultar frequência e andamento de uma turma

cURL

curl --request GET \
  --url https://api.followw.app/classrooms/{classroom_id}/frequency

200

{
  "progress": {
    "taught": 123,
    "total": 123,
    "percentage": 123
  },
  "frequency_status": "nao_registrada",
  "lessons": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "occurred_on": "2023-12-25",
      "start_time": "<string>",
      "end_time": "<string>",
      "status": "presente",
      "absences": 0,
      "marked": false
    }
  ],
  "totals": {
    "presences": 123,
    "absences": 123,
    "percentage": 123,
    "max_absences": 123,
    "estimated": true
  }
}

Headers

Cache-Control · string | null

no-cache (ou max-age=0) busca na origem antes de responder; max-age=N aceita cache de até N s; stale-if-error[=N] devolve o cache se a origem falhar; only-if-cached nunca busca (504 sem cache).

Path Parameters

classroom_id · string · required

Classroom.id ou Classroom.sigaa_id.

Response

200

application/json

Successful Response

progress · ClassroomProgress · object · required

O "Andamento das Aulas" da turma virtual: quanto da CH já foi ministrada.

Show child attributes

frequency_status · enum<string> · required

Quanto das entradas publicadas o docente já registrou.

Available options: nao_registrada, parcialmente_registrada, registrada

lessons · Lesson · object[] · required

Show child attributes

totals · FrequencyTotals · object | null · required

Presenças, faltas e frequência, pela chamada do SIGAA e as marcações do aluno.

Show child attributes