Relatórios e documentos da turma
Documentos impressos de uma turma: registros de presença, listas de alunos, protocolos de entrega, programações, vouchers e ofícios. Na tela Turmas > Documentos da turma, aberta pelo botão de documentos no cabeçalho da turma, o usuário escolhe o documento e o sistema gera o arquivo. Na API, cada documento é um endpoint de leitura que devolve o PDF. O {class_uuid} nos caminhos é o uuid da turma. A lista de documentos disponíveis para a turma vem de GET /comercial/classes/{class_uuid}/reports.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
GET | /comercial/classes/{class_uuid}/reports | Lista os documentos disponíveis para a turma |
GET | /comercial/classes/{class_uuid}/attendance-record-report | Registro de presença completo |
GET | /comercial/classes/{class_uuid}/business-attendance-record-report | Registro de presença da empresa |
GET | /comercial/classes/{class_uuid}/attendance-record-by-date-report | Registro de presença por data |
GET | /comercial/classes/{class_uuid}/attendance-record-by-date-signed-report | Registro de presença por data, assinado |
GET | /comercial/classes/{class_uuid}/meal-ticket-delivery-record | Registro de entrega de vale-refeição |
GET | /comercial/classes/{class_uuid}/meal-ticket | Vale-refeição dos alunos |
GET | /comercial/classes/{class_uuid}/vouchers | Vouchers de alimentação e hospedagem |
GET | /comercial/classes/{class_uuid}/list-of-students-report | Lista de alunos |
GET | /comercial/classes/{class_uuid}/identification-document-delivery-report | Relatório de entrega de documentos de identificação |
GET | /comercial/classes/{class_uuid}/final-result-listing | Listagem do resultado final |
GET | /comercial/classes/{class_uuid}/business-final-result-listing | Listagem do resultado final por empresa |
GET | /comercial/classes/{class_uuid}/document-delivery-protocol | Protocolo de entrega de documentos |
GET | /comercial/classes/{class_uuid}/individual-document-delivery-protocol | Protocolo de entrega de documentos individual |
GET | /comercial/classes/{class_uuid}/business-document-delivery-protocol | Protocolo de entrega de documentos por empresa |
GET | /comercial/classes/{class_uuid}/training-completion-statement | Declaração de conclusão do treinamento |
GET | /comercial/classes/{class_uuid}/cbsp-practical-assessment-list | Lista de avaliação prática (CBSP) |
GET | /comercial/classes/{class_uuid}/caci-practical-assessment-list | Lista de avaliação prática (CACI) |
GET | /comercial/classes/{class_uuid}/navy-memorandumt | Ofício da Marinha |
GET | /comercial/classes/{class_uuid}/list-of-epi-report | Lista de EPIs |
GET | /comercial/classes/{class_uuid}/training-program-report | Programação de treinamento |
GET | /comercial/classes/{class_uuid}/training-transport-program-report | Programação de transporte |
GET | /comercial/classes/{class_uuid}/training-class-transport-program-report | Programação de transporte da turma |
Como os documentos são gerados
Todos os documentos desta página são gerados na própria chamada. A resposta é o arquivo PDF, para download, com status 200. Não há fila nem consulta posterior: a chamada espera o arquivo pronto. O arquivo temporário é apagado depois do envio.
Alguns documentos têm layout próprio para o cliente. Quando o cliente tem modelo específico, o layout muda, mas o caminho e os parâmetros são os mesmos.
Documentos disponíveis por situação
A lista de reports depende da situação da turma e do curso:
| Situação | Documentos |
|---|---|
| Sempre | attendance-record-report, business-attendance-record-report, attendance-record-by-date-report, attendance-record-by-date-signed-report, meal-ticket-delivery-record, vouchers, list-of-students-report, identification-document-delivery-report, final-result-listing, business-final-result-listing, training-program-report, training-transport-program-report, training-class-transport-program-report |
| Turma Concluída | document-delivery-protocol, individual-document-delivery-protocol, business-document-delivery-protocol |
| Curso com credenciamento de avaliação prática | cbsp-practical-assessment-list, caci-practical-assessment-list |
| Curso com credenciamento de avaliação prática e turma Concluída | navy-memorandumt (Ofício da Marinha) |
| Curso com carga horária prática | list-of-epi-report (Lista de EPIs) |
Endpoints
GET /comercial/classes/{class_uuid}/reports
Lista os documentos disponíveis para a turma, conforme a tabela acima. Cada item traz id, que é o caminho do documento sem o prefixo da turma, e name, o nome do documento.
Resposta
Status 200, com a lista de documentos.
curl "https://api.pedagogo.app/comercial/classes/<uuid-da-turma>/reports" \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Accept: application/json"
GET /comercial/classes/{class_uuid}/attendance-record-report
Registro de presença completo da turma.
Resposta
Status 200, com o PDF.
GET /comercial/classes/{class_uuid}/business-attendance-record-report
Registro de presença da empresa.
Resposta
Status 200, com o PDF.
GET /comercial/classes/{class_uuid}/attendance-record-by-date-report
Registro de presença por data.
Resposta
Status 200, com o PDF.
GET /comercial/classes/{class_uuid}/attendance-record-by-date-signed-report
Registro de presença por data, na versão assinada.
Resposta
Status 200, com o PDF.
GET /comercial/classes/{class_uuid}/meal-ticket-delivery-record
Registro de entrega de vale-refeição da turma.
Resposta
Status 200, com o PDF.
GET /comercial/classes/{class_uuid}/meal-ticket
Vale-refeição dos alunos da turma. Aceita o filtro de um aluno.
Parâmetros de URL
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
customer | Não | Identificador numérico do aluno no cadastro de alunos do cliente. Sem ele, o documento traz os alunos da turma |
Resposta
Status 200, com o PDF.
GET /comercial/classes/{class_uuid}/vouchers
Vouchers de alimentação e hospedagem dos alunos da turma.
Resposta
Status 200, com o PDF.
GET /comercial/classes/{class_uuid}/list-of-students-report
Lista de alunos da turma.
Resposta
Status 200, com o PDF.
GET /comercial/classes/{class_uuid}/identification-document-delivery-report
Relatório de entrega de documentos de identificação dos alunos.
Resposta
Status 200, com o PDF.
GET /comercial/classes/{class_uuid}/final-result-listing
Listagem do resultado final da turma.
Resposta
Status 200, com o PDF.
GET /comercial/classes/{class_uuid}/business-final-result-listing
Listagem do resultado final da turma, agrupada por empresa.
Resposta
Status 200, com o PDF.
GET /comercial/classes/{class_uuid}/document-delivery-protocol
Protocolo de entrega de documentos da turma, geral. Disponível com a turma Concluída.
Resposta
Status 200, com o PDF.
GET /comercial/classes/{class_uuid}/individual-document-delivery-protocol
Protocolo de entrega de documentos individual, para pessoa física. Disponível com a turma Concluída.
Resposta
Status 200, com o PDF.
GET /comercial/classes/{class_uuid}/business-document-delivery-protocol
Protocolo de entrega de documentos por empresa. Disponível com a turma Concluída.
Resposta
Status 200, com o PDF.
GET /comercial/classes/{class_uuid}/training-completion-statement
Declaração de conclusão do treinamento. Usa o modelo padrão configurado para o cliente.
Resposta
Status 200, com o PDF.
GET /comercial/classes/{class_uuid}/cbsp-practical-assessment-list
Lista de avaliação prática no modelo CBSP. Disponível quando o curso tem credenciamento de avaliação prática.
Resposta
Status 200, com o PDF.
GET /comercial/classes/{class_uuid}/caci-practical-assessment-list
Lista de avaliação prática no modelo CACI. Disponível quando o curso tem credenciamento de avaliação prática.
Resposta
Status 200, com o PDF.
GET /comercial/classes/{class_uuid}/navy-memorandumt
Ofício da Marinha. Disponível com a turma Concluída e com o curso credenciado para avaliação prática. O modelo do ofício pode ser específico do cliente.
Resposta
Status 200, com o PDF.
GET /comercial/classes/{class_uuid}/list-of-epi-report
Lista de EPIs da turma. Disponível quando o curso tem carga horária prática.
Resposta
Status 200, com o PDF.
GET /comercial/classes/{class_uuid}/training-program-report
Programação de treinamento da turma.
Resposta
Status 200, com o PDF.
GET /comercial/classes/{class_uuid}/training-transport-program-report
Programação de transporte dos alunos da turma, no período informado.
Parâmetros de URL
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
start_date | Não | Início do período. Com end_date, filtra as matrículas que começam e terminam dentro do intervalo |
end_date | Não | Fim do período |
Resposta
Status 200, com o PDF.
GET /comercial/classes/{class_uuid}/training-class-transport-program-report
Programação de transporte da turma, no período informado.
Parâmetros de URL
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
start_date | Não | Início do período. Com end_date, filtra as matrículas que começam e terminam dentro do intervalo |
end_date | Não | Fim do período |
Resposta
Status 200, com o PDF.