Escolar

Turmas, alunos, pautas, presenças e propinas.

O módulo principal de um colégio. As propinas emitem-se pelo comercial, e por isso são faturas a sério, com série e NIF: uma propina não é um recibo interno, e uma escola que emita recibos internos tem um problema com a AGT à espera dela.

O que a licença destranca#

Este módulo exige a funcionalidade escolar na licença. Sem ela, as rotas dele respondem 403 e o menu não o mostra.

Precisa de: armazem, comercial. Sem eles, este módulo não faz o que promete.

Aproveita: rh. Sem eles funciona, e faz menos.

É o módulo principal de: Escolas e colégios.

O que se consegue ver a acontecer#

• Uma turma tem horário, e as presenças marcam-se por tempo letivo, com o atraso de quem chega tarde
• Cada aula dada tem sumário e número de lição, e o livro de ponto mostra as que ficaram por escrever
• O professor faz a chamada, lança as notas e escreve o sumário só das turmas que são dele
• A pauta lança-se por período, e o boletim sai dela
• A propina do mês emite-se para a turma inteira de uma vez
• Quem está em atraso aparece numa lista, sem ninguém a construir
• O autocarro tem rotas com paragens e preço, e a lista de cada rota sai impressa para quem conduz
• As declarações, os certificados e as segundas vias cobram-se avulso, com documento
• O extrato do aluno mostra as propinas, o transporte e as taxas separados, e o mapa de receita diz de onde veio cada kwanza

Os 83 endpoints#

Saem da árvore de rotas montada, que é a mesma que serve os pedidos. A referência completa, com corpos e respostas, está em /api.

Método	Caminho	O que faz
GET	/api/v1/escolar/alunos	Os alunos da escola
POST	/api/v1/escolar/alunos	Inscreve uma pessoa na escola
GET	/api/v1/escolar/alunos/:id	Um aluno, com o percurso dele
PUT	/api/v1/escolar/alunos/:id	Muda a ficha de um aluno
GET	/api/v1/escolar/anos-letivos	Os anos letivos da escola
POST	/api/v1/escolar/anos-letivos	Abre um ano letivo
PUT	/api/v1/escolar/anos-letivos/:id	Muda um ano letivo
GET	/api/v1/escolar/assiduidade	A assiduidade de uma turma
GET	/api/v1/escolar/avaliacoes	Os momentos de avaliação
POST	/api/v1/escolar/avaliacoes	Abre um momento de avaliação
PUT	/api/v1/escolar/avaliacoes/:id/fechar	Fecha ou reabre uma avaliação
PUT	/api/v1/escolar/avaliacoes/:id/notas	Lança a pauta de uma avaliação
GET	/api/v1/escolar/boletins/:id	O boletim de uma matrícula
GET	/api/v1/escolar/boletins/:id/documento	O boletim em PDF, xlsx ou csv
GET	/api/v1/escolar/configuracao	As decisões desta escola
PUT	/api/v1/escolar/configuracao	Grava as decisões desta escola
GET	/api/v1/escolar/curriculos	Os planos de estudo, com as disciplinas de cada um
POST	/api/v1/escolar/curriculos	Escreve o plano de estudos de um curso numa classe
GET	/api/v1/escolar/curriculos/:id	Um plano de estudos
PUT	/api/v1/escolar/curriculos/:id	Corrige um plano de estudos
GET	/api/v1/escolar/cursos	Os percursos da escola
POST	/api/v1/escolar/cursos	Abre um percurso
PUT	/api/v1/escolar/cursos/:id	Corrige um curso
GET	/api/v1/escolar/disciplinas	As matérias da escola
POST	/api/v1/escolar/disciplinas	Abre uma matéria
PUT	/api/v1/escolar/disciplinas/:id	Corrige uma disciplina
GET	/api/v1/escolar/emolumentos	O preçário da secretaria
POST	/api/v1/escolar/emolumentos	Escreve quanto custa uma declaração, um certificado, uma segunda via
PUT	/api/v1/escolar/emolumentos/:id	Corrige um emolumento
POST	/api/v1/escolar/emolumentos/cobrar	Cobra uma taxa de secretaria, avulso, e emite o documento
GET	/api/v1/escolar/horarios	A grelha semanal
POST	/api/v1/escolar/horarios	Marca uma aula
DELETE	/api/v1/escolar/horarios/:id	Tira uma aula da grelha
GET	/api/v1/escolar/livro-de-ponto	As aulas dadas, e as do horário que passaram sem sumário
GET	/api/v1/escolar/matriculas	As matrículas, pela ordem da pauta
POST	/api/v1/escolar/matriculas	Matricula um aluno numa turma
GET	/api/v1/escolar/matriculas/:id	Uma matrícula, com a conta corrente e o extrato
POST	/api/v1/escolar/matriculas/:id/anular	Fecha a passagem de um aluno pela escola
GET	/api/v1/escolar/matriculas/:id/boletim	O boletim de uma matrícula
POST	/api/v1/escolar/matriculas/:id/transferir	Muda um aluno de turma
GET	/api/v1/escolar/ofertas	Os cursos postos à venda, com quantos alunos já lá estão
POST	/api/v1/escolar/ofertas	Põe um curso à venda num ano e num turno
GET	/api/v1/escolar/ofertas/:id	Uma oferta, com quantos alunos já lá estão
PUT	/api/v1/escolar/ofertas/:id	Corrige uma oferta
GET	/api/v1/escolar/painel	Os números da entrada do módulo
GET	/api/v1/escolar/pautas	A pauta de uma disciplina de turma, num período
GET	/api/v1/escolar/planos-propinas	Quanto custa um ano
POST	/api/v1/escolar/planos-propinas	Escreve um plano de propinas
PUT	/api/v1/escolar/planos-propinas/:id	Muda um plano de propinas
GET	/api/v1/escolar/presencas	Os registos de chamada
POST	/api/v1/escolar/presencas	Marca a chamada de uma aula
GET	/api/v1/escolar/propinas	As cobranças da conta corrente dos alunos
POST	/api/v1/escolar/propinas/:id/isentar	Perdoa uma prestação, com motivo escrito
POST	/api/v1/escolar/propinas/:id/pagar	Recebe uma propina e emite o recibo
POST	/api/v1/escolar/propinas/cobranca	Corre a cobrança do dia
POST	/api/v1/escolar/propinas/emitir	Emite a prestação de um mês a uma turma inteira
GET	/api/v1/escolar/regras-avaliacao	Como esta escola calcula a média
POST	/api/v1/escolar/regras-avaliacao	Escreve uma regra de avaliação
PUT	/api/v1/escolar/regras-avaliacao/:id	Muda uma regra de avaliação
GET	/api/v1/escolar/relatorios/alunos	Quem anda na escola, por turma
GET	/api/v1/escolar/relatorios/aproveitamento	Como vão as notas
GET	/api/v1/escolar/relatorios/assiduidade	Quem falta
GET	/api/v1/escolar/relatorios/inadimplencia	Quem deve, e há quanto tempo
GET	/api/v1/escolar/relatorios/receita	De onde é que o dinheiro da escola vem
GET	/api/v1/escolar/sumarios	Os sumários, pela ordem das lições
POST	/api/v1/escolar/sumarios	Escreve o sumário de uma aula
GET	/api/v1/escolar/sumarios/:id	Um sumário, com a chamada aluno a aluno
PUT	/api/v1/escolar/sumarios/:id	Corrige o texto de um sumário
GET	/api/v1/escolar/transporte/inscricoes	Quem anda no autocarro
POST	/api/v1/escolar/transporte/inscricoes	Põe um aluno numa rota, e gera-lhe a cobrança do transporte
POST	/api/v1/escolar/transporte/inscricoes/:id/cancelar	Tira um aluno do autocarro
GET	/api/v1/escolar/transporte/rotas	As carreiras do autocarro, com as paragens e quem anda nelas
POST	/api/v1/escolar/transporte/rotas	Declara uma rota, com paragens e preço
GET	/api/v1/escolar/transporte/rotas/:id	Uma rota, com o percurso e os inscritos
PUT	/api/v1/escolar/transporte/rotas/:id	Corrige uma rota
GET	/api/v1/escolar/transporte/rotas/:id/alunos	A folha que o motorista leva na mão
GET	/api/v1/escolar/turmas	As turmas
POST	/api/v1/escolar/turmas	Abre uma turma
GET	/api/v1/escolar/turmas/:id	Uma turma
PUT	/api/v1/escolar/turmas/:id	Corrige uma turma
GET	/api/v1/escolar/turmas/:id/disciplinas	As disciplinas de uma turma, com o professor de cada uma
POST	/api/v1/escolar/turmas/:id/disciplinas	Põe uma disciplina numa turma, com professor
DELETE	/api/v1/escolar/turmas/:id/disciplinas/:disciplinaID	Tira uma disciplina do plano de uma turma