Séries e Anos

As séries e anos disponíveis para o cliente. Cada série pode ter um nome customizado por cliente (campo display_name). Endpoint de leitura.

O modelo série

id uuid

Identificador único da série.

name string

Nome da série (display_name do cliente quando disponível).

segment string|null

Nome do segmento educacional.

order integer

Ordem da série na listagem do cliente.

Modelo série

{
  "id": "a1b2c3d4-...",
  "name": "5º Ano",
  "segment": "Ensino Fundamental",
  "order": 5
}

GET /v1/partners/grades/all

Listar séries

Lista todas as séries adotadas pelo cliente, ordenadas pelo campo order. Esta rota é de escopo do cliente, não requer CNPJ de escola.

Códigos de resposta

200

Sucesso.

401

Autenticação inválida.

Requisição GET

GET /v1/partners/grades/all

curl https://toakiescola.com.br/api/v1/partners/grades/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/grades/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/grades/all', {
    headers: {
        'X-Authorization': '{api_token}',
        'X-Partner':       '{partner_token}',
        'X-Client':        '{client_slug}',
    },
});

Resposta

{
  "data": [
    {
      "id": "a1b2c3d4-...",
      "name": "5º Ano",
      "segment": "Ensino Fundamental",
      "order": 5
    }
  ]
}

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

{
  "message": "Cliente ou parceiro não encontrado."
}