Relatórios da turma
Documentos em PDF gerados a partir de uma turma. Na tela Turmas, a ação Gerar relatórios lista os documentos disponíveis para a turma, e cada documento é aberto na tela. A carta de confirmação de treinamento é gerada por aluno, na aba Alunos, pela ação Visualizar carta de confirmação. Os caminhos começam por /operational/classes/{class_uuid}/, em que {class_uuid} é o uuid da turma (veja a visão geral de turmas).
Os relatórios da turma são diferentes dos relatórios gerais, que ficam na tela Relatórios do módulo Operacional.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /operational/classes/{class_uuid}/reports | Lista os documentos disponíveis para a turma |
| GET | /operational/classes/{class_uuid}/attendance-record-report | Registro de Presença (PDF) |
| GET | /operational/classes/{class_uuid}/business-attendance-record-report | Registro de Presença da Empresa (PDF) |
| GET | /operational/classes/{class_uuid}/attendance-record-by-date-report | Registro de Presença por Data (PDF) |
| GET | /operational/classes/{class_uuid}/attendance-record-by-date-signed-report | Registro de Presença por Data Assinado (PDF) |
| GET | /operational/classes/{class_uuid}/meal-ticket-delivery-record | Registro de entrega de vale-refeição (PDF) |
| GET | /operational/classes/{class_uuid}/meal-ticket | Vale refeição (PDF) |
| GET | /operational/classes/{class_uuid}/list-of-students-report | Lista de alunos (PDF) |
| GET | /operational/classes/{class_uuid}/identification-document-delivery-report | Relatório de entrega de documentos de identificação (PDF) |
| GET | /operational/classes/{class_uuid}/final-result-listing | Listagem do Resultado Final (PDF) |
| GET | /operational/classes/{class_uuid}/business-final-result-listing | Listagem de resultado final por empresa (PDF) |
| GET | /operational/classes/{class_uuid}/document-delivery-protocol | Protocolo de entrega de documentos (PDF) |
| GET | /operational/classes/{class_uuid}/individual-document-delivery-protocol | Protocolo de entrega de documentos - PF (PDF) |
| GET | /operational/classes/{class_uuid}/business-document-delivery-protocol | Protocolo de entrega de documentos por empresa (PDF) |
| GET | /operational/classes/{class_uuid}/cbsp-practical-assessment-list | Lista de avaliação prática do CBSP (PDF) |
| GET | /operational/classes/{class_uuid}/caci-practical-assessment-list | Lista de avaliação prática do CACI (PDF) |
| GET | /operational/classes/{class_uuid}/navy-memorandumt | Ofício da Marinha (PDF) |
| GET | /operational/classes/{class_uuid}/list-of-epi-report | Lista de EPIs (PDF) |
| GET | /operational/classes/{class_uuid}/training-program-report | Programação de treinamento (PDF) |
| GET | /operational/classes/{class_uuid}/training-transport-program-report | Programação de transporte de treinamento (PDF) |
| GET | /operational/classes/{class_uuid}/students/report/training-confirmation-letter | Carta de Confirmação de Treinamento, por aluno (PDF) |
GET /operational/classes/{class_uuid}/reports
Lista os documentos que podem ser gerados para a turma. Corresponde à ação Gerar relatórios da tela Turmas. A lista depende da turma:
- Os registros de presença, o registro de entrega de vale-refeição, a lista de alunos, o relatório de entrega de documentos de identificação, as listagens de resultado final, a programação de treinamento e a programação de transporte aparecem sempre.
- Os protocolos de entrega de documentos aparecem quando a turma está Concluída.
- As listas de avaliação prática do CBSP e do CACI aparecem quando o curso tem credenciamento. O ofício da Marinha aparece nesse caso, com a turma concluída.
- A lista de EPIs aparece quando o curso tem carga horária prática.
A lista pode incluir documentos de outras telas que não fazem parte desta referência.
Resposta
Status 200, com uma lista direta (sem paginação). Cada item traz:
| Campo | Descrição |
|---|---|
| id | Identificador do documento. É o último trecho do caminho do endpoint correspondente |
| name | Nome do documento, em inglês, como devolvido pela API. A tela mostra o rótulo em português |
Exemplo de resposta, com a turma concluída:
[
{ "id": "attendance-record-report", "name": "Attendance Record" },
{ "id": "document-delivery-protocol", "name": "Document Delivery Protocol" }
]
Exemplo
curl "https://api.pedagogo.app/operational/classes/<uuid-da-turma>/reports" \
-H "Accept: application/json" \
-H "Authorization: Bearer <token-de-sessao>"
Documentos em PDF da turma
Os endpoints de documento da tabela acima têm o mesmo comportamento:
- Não recebem corpo. O uuid da turma vai no caminho.
- Geram o documento no momento da chamada e respondem com o arquivo PDF para download, com status 200. O layout segue a configuração de cada empresa cliente.
- Não há formato Excel nesses documentos.
Os documentos com filtros próprios estão nas subseções abaixo. Os demais não recebem parâmetros.
Exemplo
curl -o registro-de-presenca.pdf \
"https://api.pedagogo.app/operational/classes/<uuid-da-turma>/attendance-record-report" \
-H "Accept: application/pdf" \
-H "Authorization: Bearer <token-de-sessao>"
GET /operational/classes/{class_uuid}/meal-ticket
Vale refeição da turma, em PDF. Considera os alunos da turma que têm despesas de treinamento lançadas.
Parâmetros de URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| customer | número | Não | Id numérico do cadastro do aluno. Restringe o vale ao aluno informado |
Resposta
Status 200 com o arquivo PDF para download.
GET /operational/classes/{class_uuid}/training-transport-program-report
Programação de transporte de treinamento da turma, em PDF.
Parâmetros de URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| start_date | data | Não | Início do período. Com end_date, considera os alunos cujas datas de início e de término ficam dentro do período. Sozinho, considera os alunos com data de início nesse dia |
| end_date | data | Não | Fim do período. Com start_date, o mesmo critério acima. Sozinho, considera os alunos com data de término nesse dia |
Resposta
Status 200 com o arquivo PDF para download.
GET /operational/classes/{class_uuid}/students/report/training-confirmation-letter
Carta de Confirmação de Treinamento dos alunos informados. Corresponde à ação Visualizar carta de confirmação da aba Alunos da turma. Gera uma carta por aluno, em um único PDF.
Parâmetros de URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| uuids | lista de textos | Sim | Uuids dos cadastros dos alunos (cadastro do aluno, não da matrícula) |
Sem uuids, a carta não traz nenhum aluno.
Resposta
Status 200 com o arquivo PDF para download.
Exemplo
curl -G "https://api.pedagogo.app/operational/classes/<uuid-da-turma>/students/report/training-confirmation-letter" \
--data-urlencode "uuids[]=<uuid-do-cadastro-do-aluno>" \
-H "Accept: application/pdf" \
-H "Authorization: Bearer <token-de-sessao>" \
-o carta-de-confirmacao.pdf