Tipos de Aula

Os tipos de aula representam os modelos de período letivo (por exemplo: aula regular de 50min, aula dupla, recreio, etc.) cadastrados em uma escola. Estes endpoints são apenas de leitura.

O modelo tipo de aula

id uuid

Identificador único.

name string

Nome do tipo de aula (até 50 caracteres).

duration_minutes integer

Duração em minutos.

school_cnpj string

CNPJ da escola.

Modelo tipo de aula

{
  "id": "a1b2c3d4-...",
  "name": "Aula Regular",
  "duration_minutes": 50,
  "school_cnpj": "26019466000122"
}

GET /v1/partners/school/{cnpj}/class-period-types/all

Listar tipos de aula

Retorna todos os tipos de aula cadastrados na escola. Resposta paginada.

Parâmetros de rota

cnpj string obrigatório

CNPJ da escola (14 dígitos, sem formatação).

Códigos de resposta

200

Sucesso.

401

Autenticação inválida.

404

Escola não encontrada.

Requisição GET

GET /v1/partners/school/{cnpj}/class-period-types/all

curl https://toakiescola.com.br/api/v1/partners/school/26019466000122/class-period-types/all \
  -H "X-Authorization: {api_token}" \
  -H "X-Partner: {partner_token}" \
  -H "X-Client: {client_slug}"

$client->get('https://toakiescola.com.br/api/v1/partners/school/26019466000122/class-period-types/all', [
    'headers' => [
        'X-Authorization' => '{api_token}',
        'X-Partner'       => '{partner_token}',
        'X-Client'        => '{client_slug}',
    ],
]);

const res = await fetch('https://toakiescola.com.br/api/v1/partners/school/26019466000122/class-period-types/all', {
    headers: {
        'X-Authorization': '{api_token}',
        'X-Partner':       '{partner_token}',
        'X-Client':        '{client_slug}',
    },
});

Resposta

{
  "data": [
    {
      "id": "a1b2c3d4-...",
      "name": "Aula Regular",
      "duration_minutes": 50,
      "school_cnpj": "26019466000122"
    }
  ],
  "meta": { /* metadados de paginação */ }
}

{
  "message": "Autenticação inválida."
}

{
  "message": "Escola não encontrada."
}

GET /v1/partners/school/{cnpj}/class-period-type/{id}

Obter tipo de aula

Retorna um tipo de aula pelo UUID.