Boletins

O endpoint de boletins retorna o desempenho completo de um aluno em uma turma: notas por disciplina e período, médias, frequência e situação final (aprovado, reprovado ou cursando). O cálculo segue as regras da Forma de Avaliação configurada para a turma.

A estrutura do boletim

O boletim é retornado como um objeto com as disciplinas do aluno. Para cada disciplina, há notas por período, médias calculadas e situação do período. O objeto raiz também inclui informações de frequência e a situação final do aluno.

Campos raiz

student object

Dados básicos do aluno (id, name, enrollment_number).

classroom object

Dados da turma (id, name).

form_of_evaluation object

Forma de avaliação usada: nome, número de períodos, nota máxima e média de aprovação.

subjects array

Lista de disciplinas com notas, médias por período e situação.

attendance object

Resumo de frequência: total de aulas, faltas, percentual de presença e situação (aprovado/reprovado por frequência).

final object

Situação final do aluno: status (approved, failed, in_progress) e mensagem legível.

Estrutura do boletim 
{
  "student": {
    "id": "d4e5f6a7-...",
    "name": "João Silva",
    "enrollment_number": "7.553"
  },
  "classroom": {
    "id": "b2c3d4e5-...",
    "name": "5º Ano A"
  },
  "form_of_evaluation": {
    "name": "Avaliação Bimestral",
    "periods": 4,
    "max_score": 10,
    "passing_average": 6
  },
  "subjects": [
    {
      "id": "c3d4e5f6-...",
      "name": "Matemática",
      "periods": [
        {
          "period": 1,
          "scores": [
            { "label": "Prova", "score": 8.5 }
          ],
          "average": 8.5,
          "status": "approved"
        }
      ],
      "final_average": 8.5,
      "status": "approved"
    }
  ],
  "attendance": {
    "total_lessons": 200,
    "absences": 12,
    "attendance_percentage": 94,
    "status": "approved"
  },
  "final": {
    "status": "approved",
    "label": "Aprovado"
  }
}
GET /v1/partners/school/{cnpj}/classroom/{classroom_id}/student/{enrollment_number}/report-card

Obter boletim do aluno

Retorna o boletim completo de um aluno na turma especificada. Requer que a turma tenha uma Forma de Avaliação configurada. O número de matrícula deve pertencer a um aluno matriculado na turma.

Parâmetros de rota

cnpj string obrigatório

CNPJ da escola (14 dígitos).

classroom_id string (uuid) obrigatório

Identificador único da turma.

enrollment_number string obrigatório

Número de matrícula do aluno.

Códigos de resposta

200

Boletim retornado com sucesso.

401

Autenticação inválida.

404

Escola, turma ou aluno não encontrado.

422

A turma não possui Forma de Avaliação configurada.

Requisição GET
curl https://toakiescola.com.br/api/v1/partners/school/26019466000122/classroom/b2c3d4e5-.../student/7.553/report-card \
  -H "X-Authorization: {api_token}" \
  -H "X-Partner: {partner_token}" \
  -H "X-Client: {client_slug}"
Resposta 
{
  "data": {
    "student": { ... },
    "classroom": { ... },
    "form_of_evaluation": { ... },
    "subjects": [ ... ],
    "attendance": { ... },
    "final": {
      "status": "approved",
      "label": "Aprovado"
    }
  }
}