> ## 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 das turmas atuais



## OpenAPI

````yaml /mintlify/openapi.json get /classrooms/frequency
openapi: 3.1.0
info:
  title: Followw UnB API
  description: >-
    API independente e open-source para consultar dados do SIGAA e de outros
    sistemas da UnB. O acesso autenticado usa a conta do SIGAA, com sessão por
    cookies.
  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: Login no SIGAA e sessão por cookies.
  - name: Classrooms
    description: Turmas, participantes, frequência e resultados acadêmicos.
  - name: Me
    description: Perfil, configurações, documentos e acesso ao RU.
  - name: Public Classrooms
    description: Turmas e unidades do SIGAA.
    x-displayName: Classrooms
  - name: Public Courses
    description: Cursos e currículos por ingresso.
    x-displayName: Courses
  - name: Public Professors
    description: Catálogo de docentes.
    x-displayName: Professors
  - name: Public Restaurant
    description: Cardápio do RU.
    x-displayName: Restaurant
  - name: Public Search
    description: Busca de matérias, cursos e docentes.
    x-displayName: Search
  - name: Public Subjects
    description: Matérias de graduação e suas turmas.
    x-displayName: Subjects
  - name: Posts
    description: Notícias e avaliações das turmas.
paths:
  /classrooms/frequency:
    get:
      tags:
        - Classrooms
      summary: Consultar frequência das turmas atuais
      operationId: get_current_frequencies_classrooms_frequency_get
      parameters:
        - name: Cache-Control
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              `no-cache`: revalidar; `max-age=N`: idade máxima em segundos;
              `stale-if-error[=N]`: aceitar cache na falha; `only-if-cached`:
              usar só cache (504 se ausente).
            title: Cache-Control
          description: >-
            `no-cache`: revalidar; `max-age=N`: idade máxima em segundos;
            `stale-if-error[=N]`: aceitar cache na falha; `only-if-cached`: usar
            só cache (504 se ausente).
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClassroomFrequencyResult'
                title: Response Get Current Frequencies Classrooms Frequency Get
        '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:
    ClassroomFrequencyResult:
      properties:
        classroom:
          $ref: '#/components/schemas/ParticipantClassroom'
        frequency:
          $ref: '#/components/schemas/ClassroomFrequencyView'
      type: object
      required:
        - classroom
        - frequency
      title: ClassroomFrequencyResult
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ParticipantClassroom:
      properties:
        professors:
          items:
            $ref: '#/components/schemas/ProfessorRef'
          type: array
          title: Professors
          default: []
        vacancies:
          anyOf:
            - type: integer
            - type: 'null'
          title: Vacancies
          description: Vagas na última coleta, sem atualização em tempo real.
        occupied:
          anyOf:
            - type: integer
            - type: 'null'
          title: Occupied
          description: Ocupação na última coleta, sem atualização em tempo real.
        id:
          type: string
          title: Id
        sigaa_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Sigaa Id
        number:
          type: string
          title: Number
        semester:
          type: string
          title: Semester
        schedule:
          anyOf:
            - type: string
            - type: 'null'
          title: Schedule
        room:
          anyOf:
            - type: string
            - type: 'null'
          title: Room
        current:
          type: boolean
          title: Current
          default: false
        subject:
          $ref: '#/components/schemas/UserSubject'
        grade:
          anyOf:
            - $ref: '#/components/schemas/Grade'
            - type: 'null'
        status:
          anyOf:
            - $ref: '#/components/schemas/ClassroomStatus'
            - type: 'null'
      type: object
      required:
        - id
        - number
        - semester
        - subject
      title: ParticipantClassroom
      description: >-
        A turma com a menção do usuário, `None` enquanto não lançada ou
        sincronizada.
    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
    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
    ProfessorRef:
      properties:
        siape:
          anyOf:
            - type: integer
            - type: 'null'
          title: Siape
        name:
          type: string
          title: Name
        photo:
          anyOf:
            - type: string
            - type: 'null'
          title: Photo
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
      type: object
      required:
        - siape
        - name
        - photo
        - email
      title: ProfessorRef
      description: Docente da turma; `siape` nulo fora do catálogo.
    UserSubject:
      properties:
        code:
          type: string
          title: Code
        name:
          type: string
          title: Name
        hours:
          anyOf:
            - type: integer
            - type: 'null'
          title: Hours
        unit:
          anyOf:
            - $ref: '#/components/schemas/UnitRef'
            - type: 'null'
      type: object
      required:
        - code
        - name
      title: UserSubject
      description: Matéria identificada pelo código.
    Grade:
      type: string
      enum:
        - SS
        - MS
        - MM
        - MI
        - II
        - SR
      title: Grade
    ClassroomStatus:
      type: string
      enum:
        - cursando
        - trancado
        - concluido
        - pending_enrollment
        - denied
      title: ClassroomStatus
    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.
    UnitRef:
      properties:
        id:
          type: integer
          title: Id
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
        name:
          type: string
          title: Name
      type: object
      required:
        - id
        - code
        - name
      title: UnitRef
      description: 'Unidade acadêmica: `id` do SIGAA e sigla em `code`.'
    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.