> ## Documentation Index
> Fetch the complete documentation index at: https://docs.followw.app/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /mintlify/openapi.json get /classrooms/{classroom_id}/frequency
openapi: 3.1.0
info:
  title: Followw UnB API
  description: >-
    Cliente alternativo e open-source para o ecossistema de sistemas da
    Universidade de Brasília (UnB). Agrega em uma experiência unificada e
    performática dados do SIGAA, Restaurante Universitário (RU) e calendário
    oficial, com autenticação stateless delegada ao CAS da UnB, credenciais
    cifradas em cookies JWE (AES-256-GCM), sincronização assíncrona inteligente
    e cache resiliente via Stale-While-Revalidate.
  version: 0.1.0
servers:
  - url: https://api.followw.app
    description: Produção
  - url: http://localhost:8000
    description: Desenvolvimento local
security: []
tags:
  - name: Auth
    description: >-
      Autenticação via SIGAA/CAS da UnB e gerenciamento de sessão stateless por
      cookies.
  - name: Classrooms
    description: >-
      Turmas do semestre e histórico, participantes, frequência e estatísticas
      de aprovação.
  - name: Me
    description: >-
      Perfil acadêmico, extrato/saldo do RU e carteirinha do estudante
      autenticado.
  - name: Public Classrooms
    description: Busca pública de turmas e unidades do SIGAA, sem autenticação.
    x-displayName: Classrooms
  - name: Public Courses
    description: >-
      Cursos cadastrados e seus currículos por semestre de ingresso, sem
      autenticação.
    x-displayName: Courses
  - name: Public Professors
    description: Catálogo público de docentes do SIGAA, sem autenticação.
    x-displayName: Professors
  - name: Public Restaurant
    description: Cardápio público do RU, sem autenticação.
    x-displayName: Restaurant
  - name: Public Subjects
    description: Componentes curriculares de graduação e suas turmas, sem autenticação.
    x-displayName: Subjects
  - name: Posts
    description: >-
      Notícias e avaliações recentes das turmas, consultadas diretamente na home
      do SIGAA.
paths:
  /classrooms/{classroom_id}/frequency:
    get:
      tags:
        - Classrooms
      summary: Consultar frequência e andamento de uma turma
      description: >-
        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.
      operationId: get_classroom_frequency_classrooms__classroom_id__frequency_get
      parameters:
        - name: classroom_id
          in: path
          required: true
          schema:
            type: string
            description: Classroom.id ou Classroom.sigaa_id.
            title: Classroom Id
          description: Classroom.id ou Classroom.sigaa_id.
        - name: Cache-Control
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              `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).
            title: Cache-Control
          description: >-
            `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).
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassroomFrequencyView'
        '401':
          description: Credenciais ausentes ou inválidas.
        '404':
          description: Turma não encontrada entre as turmas do usuário.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '502':
          description: SIGAA indisponível.
        '503':
          description: Cache em atualização.
components:
  schemas:
    ClassroomFrequencyView:
      properties:
        progress:
          $ref: '#/components/schemas/ClassroomProgress'
        frequency_status:
          $ref: '#/components/schemas/FrequencyStatus'
        lessons:
          items:
            $ref: '#/components/schemas/Lesson'
          type: array
          title: Lessons
        totals:
          anyOf:
            - $ref: '#/components/schemas/FrequencyTotals'
            - type: 'null'
      type: object
      required:
        - progress
        - frequency_status
        - lessons
        - totals
      title: ClassroomFrequencyView
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ClassroomProgress:
      properties:
        taught:
          type: integer
          title: Taught
        total:
          type: integer
          title: Total
        percentage:
          type: integer
          title: Percentage
      type: object
      required:
        - taught
        - total
        - percentage
      title: ClassroomProgress
      description: >-
        O "Andamento das Aulas" da turma virtual: quanto da CH já foi
        ministrada.
    FrequencyStatus:
      type: string
      enum:
        - nao_registrada
        - parcialmente_registrada
        - registrada
      title: FrequencyStatus
      description: Quanto das entradas publicadas o docente já registrou.
    Lesson:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        occurred_on:
          type: string
          format: date
          title: Occurred On
        start_time:
          anyOf:
            - type: string
              format: time
            - type: 'null'
          title: Start Time
        end_time:
          anyOf:
            - type: string
              format: time
            - type: 'null'
          title: End Time
        status:
          $ref: '#/components/schemas/LessonStatus'
        absences:
          type: integer
          title: Absences
          default: 0
        marked:
          type: boolean
          title: Marked
          default: false
      type: object
      required:
        - id
        - occurred_on
        - start_time
        - end_time
        - status
      title: Lesson
      description: Uma aula; sem horário quando o SIGAA a publicou numa turma sem horário.
    FrequencyTotals:
      properties:
        presences:
          type: integer
          title: Presences
        absences:
          type: integer
          title: Absences
        percentage:
          type: number
          title: Percentage
        max_absences:
          anyOf:
            - type: integer
            - type: 'null'
          title: Max Absences
        estimated:
          type: boolean
          title: Estimated
      type: object
      required:
        - presences
        - absences
        - percentage
        - max_absences
        - estimated
      title: FrequencyTotals
      description: >-
        Presenças, faltas e frequência, pela chamada do SIGAA e as marcações do
        aluno.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    LessonStatus:
      type: string
      enum:
        - presente
        - falta
        - nao_registrada
        - cancelada
      title: LessonStatus

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.