Auditorias da turma
Auditoria da turma é o registro do histórico das ações feitas na turma e nos alunos, como criação, alteração, cancelamento, conclusão e reabertura da turma e alterações nos dados dos alunos. Cada registro traz a ação, a descrição, o aluno ligado (quando for uma ação de aluno) e o usuário que fez a ação.
No manual de usuário, esta área é a aba Auditorias da turma, dentro do detalhe da turma (módulo Operacional). Na tela, a listagem é apenas para consulta.
Esta página cobre a consulta do histórico da turma e os lookups usados nos filtros da listagem. As regras gerais estão em Convenções e a sessão em Autenticação. Os dados da turma estão em Turmas.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /operational/classes/{class_uuid}/audits | Lista o histórico de auditoria da turma |
| GET | /operational/classes/{class_uuid}/audits/{id} | Consulta um registro de auditoria |
| GET | /operational/classes/actions | Lista as ações que podem aparecer na auditoria |
| GET | /operational/classes/audits/actions | Lista as ações que podem aparecer na auditoria (mesma listagem de /operational/classes/actions) |
| GET | /operational/classes/audits/students | Lista as matrículas sem turma, usadas nos filtros de alunos |
Listar auditorias da turma
GET /operational/classes/{class_uuid}/audits
Lista os registros de auditoria da turma informada, do mais recente para o mais antigo.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| search | Busca na descrição, no nome da ação, no nome do aluno e no nome do usuário que fez a ação |
| audit_id | Identificador de auditoria |
| column | Coluna de ordenação, com order |
| order | Sentido da ordenação: asc ou desc, com column |
| per_page | Quantidade por página. Se omitido, a lista vem completa |
| page | Número da página, com per_page |
Resposta
- 200: lista de registros ou, com
per_page, objeto paginado (veja Convenções).
Campos principais: id, class_id, student_id, customer_vendor_student_id, action_id, action (nome da ação), description, name (nome do aluno, quando houver), user_create_name (usuário que fez a ação) e created_at.
Exemplo
curl "https://api.pedagogo.app/operational/classes/<uuid-da-turma>/audits?search=Matricula&per_page=15" \
-H "Accept: application/json" \
-H "Authorization: Bearer <token-de-sessao>"
Consultar um registro
GET /operational/classes/{class_uuid}/audits/{id}
Devolve o registro de auditoria informado, com a turma a que ele pertence. O id é o identificador numérico do registro.
- 200: o registro de auditoria.
- 404: registro não encontrado.
Lookups de auditoria
GET /operational/classes/actions
Lista as ações cadastradas para a auditoria. Use o id da ação nos filtros.
Parâmetros de URL: columnName com orderData (ordenação), per_page e page.
Resposta: lista de ações, com id, action (nome da ação), status_id e status (situação da turma associada à ação).
GET /operational/classes/audits/actions
Lista as mesmas ações de GET /operational/classes/actions, com os mesmos parâmetros e a mesma resposta.
GET /operational/classes/audits/students
Lista as matrículas da empresa cliente que não estão ligadas a uma turma (cursos online). Aceita os mesmos filtros da listagem de alunos de uma turma, descritos em Alunos da turma.
Parâmetros de URL: search, student, company, status_id, per_page, page, column e order.
Resposta: lista de matrículas, com os dados do aluno, da empresa, a situação e as datas do treinamento.
Exemplo
curl "https://api.pedagogo.app/operational/classes/actions?per_page=50" \
-H "Accept: application/json" \
-H "Authorization: Bearer <token-de-sessao>"