Plano Pedagógico

O plano pedagógico registra, para uma aula específica, os objetivos, conteúdos, atividades, recursos e observações planejados pelo professor. Cada aula possui no máximo um plano pedagógico.

O modelo plano pedagógico

id uuid

Identificador do plano pedagógico.

classroom_lesson_id uuid

UUID da aula vinculada.

curriculum_plan_id uuid|null

UUID do plano de curso (BNCC) vinculado.

objetivos text|null

Objetivos da aula.

conteudos text|null

Conteúdos a serem trabalhados.

atividades text|null

Atividades planejadas.

recursos text|null

Recursos necessários.

observacoes text|null

Observações gerais.

items array

Lista de habilidades e/ou objetivos BNCC associados.

items[].habilidade_id uuid|null

UUID da habilidade BNCC.

items[].objetivo_id uuid|null

UUID do objetivo BNCC.

Modelo plano pedagógico

{
  "id": "...",
  "classroom_lesson_id": "...",
  "curriculum_plan_id": "...",
  "objetivos": "Desenvolver...",
  "conteudos": "Frações...",
  "atividades": "Exercícios...",
  "recursos": "Livro didático...",
  "observacoes": null,
  "items": []
}

GET /v1/partners/school/{cnpj}/lesson/{lesson_id}/lesson-plan

Obter Plano Pedagógico

Retorna o plano pedagógico de uma aula.

Parâmetros de rota

cnpj string obrigatório

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

lesson_id uuid obrigatório

UUID da aula.

Códigos de resposta

200

Sucesso.

401

Autenticação inválida.

404

Escola, aula ou plano não encontrado.

Requisição GET

GET /v1/partners/school/{cnpj}/lesson/{lesson_id}/lesson-plan

curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/lesson/{lesson_id}/lesson-plan \
  -H "X-Authorization: {api_token}" \
  -H "X-Partner: {partner_token}" \
  -H "X-Client: {client_slug}"

$client->get('.../v1/partners/school/{cnpj}/lesson/{lesson_id}/lesson-plan');

await fetch('.../v1/partners/school/{cnpj}/lesson/{lesson_id}/lesson-plan');

Resposta

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
    "classroom_lesson_id": "b2c3d4e5-f6a7-8901-bc23-de45fa678901",
    "curriculum_plan_id": "c3d4e5f6-a7b8-9012-cd34-ef56ab789012",
    "objetivos": "Desenvolver o raciocínio matemático.",
    "conteudos": "Frações e números decimais.",
    "atividades": "Exercícios do livro págs. 45-47.",
    "recursos": "Livro didático, quadro branco.",
    "observacoes": null,
    "items": []
  }
}

{
  "message": "Autenticação inválida. Verifique os cabeçalhos X-Authorization, X-Partner e X-Client."
}

{
  "message": "Escola, aula ou plano não encontrado."
}

POST /v1/partners/school/{cnpj}/lesson/{lesson_id}/lesson-plan

Salvar Plano Pedagógico

Cria ou atualiza o plano pedagógico de uma aula (upsert). Se já existir um plano para a aula, ele será atualizado.

Parâmetros de rota

cnpj string obrigatório

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

lesson_id uuid obrigatório

UUID da aula.

Parâmetros do corpo

curriculum_plan_id uuid opcional

UUID do plano de curso (BNCC) a vincular.

objetivos text opcional

Objetivos da aula.

conteudos text opcional

Conteúdos a serem trabalhados.

atividades text opcional

Atividades planejadas.

recursos text opcional

Recursos necessários.

observacoes text opcional

Observações gerais.

items array opcional

Quando enviado, substitui todos os itens existentes. Cada item pode ter habilidade_id e/ou objetivo_id.

Códigos de resposta

200

Plano criado ou atualizado com sucesso.

400

Dados inválidos.

401

Autenticação inválida.

404

Escola, aula ou plano não encontrado.

Requisição POST

POST /v1/partners/school/{cnpj}/lesson/{lesson_id}/lesson-plan

curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/lesson/{lesson_id}/lesson-plan \
  -X POST \
  -H "X-Authorization: {api_token}" \
  -H "X-Partner: {partner_token}" \
  -H "X-Client: {client_slug}" \
  -H "Content-Type: application/json" \
  -d '{ "curriculum_plan_id": "...", "objetivos": "...", "conteudos": "...", "atividades": "...", "recursos": "...", "observacoes": "...", "items": "..." }'

$client->post('.../v1/partners/school/{cnpj}/lesson/{lesson_id}/lesson-plan', ['json' => [/* ... */]]);

await fetch('.../v1/partners/school/{cnpj}/lesson/{lesson_id}/lesson-plan', {
  method: 'POST',
  body: JSON.stringify({/* ... */})
});

Resposta

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
    "classroom_lesson_id": "b2c3d4e5-f6a7-8901-bc23-de45fa678901",
    "curriculum_plan_id": "c3d4e5f6-a7b8-9012-cd34-ef56ab789012",
    "objetivos": "Desenvolver o raciocínio matemático.",
    "conteudos": "Frações e números decimais.",
    "atividades": "Exercícios do livro págs. 45-47.",
    "recursos": "Livro didático, quadro branco.",
    "observacoes": null,
    "items": []
  }
}

{
  "message": "Os dados fornecidos são inválidos.",
  "errors": { ... }
}

{
  "message": "Autenticação inválida. Verifique os cabeçalhos X-Authorization, X-Partner e X-Client."
}

{
  "message": "Escola, aula ou plano não encontrado."
}