Skip to content

UC-009: Caderno Online

UC-009: Caderno Online

Status: EM REVISÃO Data: 2026-04-29 Domínio: platform / activity.productive Ator: Aluno Terms: Caderno Online, Artefato do Caderno Online, Status do Artefato do Caderno, Status de Sincronia do Artefato, Versionamento Revisional de Artefato, Atividade Produtiva, Resumo, Leitura, Leitura de Reforço, Revisão Geral

Contexto

Visão navegável do acervo de artefatos produzidos pelo Aluno nas atividades de estudo. Agrupa por disciplina e unidade. Somente artefatos de atividades já concluídas ficam disponíveis — conteúdos do Bloco Atual ficam limitados ao Roteiro de Estudos (UC-005).

Simulado Escrito não compõe o Caderno Online.

Endpoints

GET /platform/study/{enrolment_id}/notebook                    → Artefatos agrupados
GET /platform/study/{enrolment_id}/notebook/{artifact_id}      → Conteúdo completo

Controller: notebook_api_controller.php

GET /platform/study/{enrolment_id}/notebook — Lista

GET /platform/study/{enrolment_id}/notebook
Authorization: Bearer {wstoken}

Resposta:

{
  "artifacts_count": 24,
  "disciplines": [
    {
      "discipline_id": 5,
      "name": "Direito Constitucional",
      "artifacts": [
        {
          "id": 10,
          "type": "summary",
          "title": "Resumo — Controle de Constitucionalidade",
          "unit": { "id": 101, "name": "Controle de Constitucionalidade" },
          "status": "synced",
          "created_at": "2026-04-20T10:00:00Z",
          "updated_at": "2026-04-20T10:30:00Z",
          "preview": "O controle de constitucionalidade é o mecanismo..."
        },
        {
          "id": 11,
          "type": "reading",
          "title": "Leitura — Direitos Fundamentais",
          "unit": { "id": 102, "name": "Direitos Fundamentais" },
          "status": "outdated",
          "created_at": "2026-04-21T09:00:00Z",
          "updated_at": "2026-04-21T09:45:00Z",
          "preview": "Os direitos fundamentais são garantias constitucionais..."
        }
      ]
    }
  ]
}

type: summary | reading | reinforcement_reading | general_review_edit status: synced (atual) | outdated (Unidade atualizada após criação do artefato)

GET /platform/study/{enrolment_id}/notebook/{artifact_id} — Detalhe

GET /platform/study/{enrolment_id}/notebook/{artifact_id}
Authorization: Bearer {wstoken}

Resposta:

{
  "id": 10,
  "type": "summary",
  "title": "Resumo — Controle de Constitucionalidade",
  "discipline": { "id": 5, "name": "Direito Constitucional" },
  "unit": { "id": 101, "name": "Controle de Constitucionalidade" },
  "content_html": "<p>O controle de constitucionalidade é o mecanismo pelo qual se verifica a compatibilidade de normas infraconstitucionais com a Constituição...</p>",
  "word_count": 350,
  "status": "synced",
  "created_at": "2026-04-20T10:00:00Z",
  "updated_at": "2026-04-20T10:30:00Z",
  "source_activity": {
    "slot_id": "550e8400-0001-0000-0000-000000000002",
    "type": "guided_study",
    "format": "summary"
  }
}

Erros esperados

HTTP Código Situação
401 unauthorized Token inválido ou expirado
404 enrolment_not_found Matrícula não encontrada
404 artifact_not_found Artefato não encontrado

Decisões

  • D-01: Agrupamento por disciplina no Backend (§16)
  • D-02: Somente artefatos de atividades concluídas (restrição do term Caderno Online)
  • D-03: status: outdated sinaliza que a Unidade de origem foi atualizada — artefato pode estar desatualizado
  • D-04: source_activity rastreia de qual slot/atividade o artefato se originou
Navigation

Type to search…

↑↓ navigate↵ selectEsc close