Avaliações
Avaliações reúne as provas das turmas. Corresponde à tela Avaliações, do módulo Operacional: a listagem de turmas com datas nos últimos 15 dias e, dentro de cada turma, as abas Alunos e Provas. Esta página descreve a listagem de turmas, a consulta de uma turma, os alunos e as provas da turma, a criação das provas e a lista de status de prova. As regras gerais estão em Convenções e a autenticação em Autenticação.
A prova do aluno (conexão, liberação de acesso, respostas, nota e relatório) não faz parte desta referência.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /operational/assessments | Lista as turmas com datas nos últimos 15 dias |
| GET | /operational/assessments/{uuid} | Consulta uma turma |
| GET | /operational/assessments/{class_uuid}/students | Lista os alunos da turma (aba Alunos) |
| GET | /operational/assessments/{class_uuid}/assessments | Lista as provas da turma (aba Provas) |
| POST | /operational/assessments/{class_uuid}/assessments | Cria as provas dos alunos da turma |
| GET | /operational/training-students-assessments-statuses | Lista os status de prova |
GET /operational/assessments
Lista as turmas do cliente cujas datas de início e de término estão entre os últimos 15 dias e a data de hoje. A janela é calculada pela API: os parâmetros start_date e end_date, se enviados, são substituídos.
Parâmetros de URL (query)
| Parâmetro | Descrição |
|---|---|
| search | Busca pelo código da turma, pelo nome ou sigla do curso, pelo nome, e-mail, celular ou documento do aluno e pelo nome ou documento da empresa |
| status_id | Situação da turma |
| course_uuid | Curso da turma |
| company_uuid | Empresa da turma |
| modality_uuid | Modalidade da turma |
| per_page | Quantidade de registros por página |
| page | Número da página, quando per_page é informado |
| column e order | Ordenação pela coluna informada, na direção asc ou desc |
Resposta: 200 OK. Sem per_page, a resposta é uma lista; com per_page, é paginada. Campos principais de cada turma: id, uuid, code, start_date, end_date, status_id, status_name, course_uuid, course_name, course_code, student_count, company_name, business_name, modality_name, location_name, user_create_name, created_at, user_update_name e updated_at.
curl -X GET "https://api.pedagogo.app/operational/assessments?per_page=15" \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Accept: application/json"
GET /operational/assessments/{uuid}
Consulta a turma pelo uuid informado. A resposta traz o curso (com as acreditações), a situação, a empresa, a modalidade e students_count, a quantidade de alunos da turma.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| uuid | uuid da turma |
Resposta: 200 OK, com o registro da turma. Turma inexistente ou de outra empresa cliente: 404.
GET /operational/assessments/{class_uuid}/students
Lista os alunos da turma, usada na aba Alunos. A tela é apenas para consulta.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| class_uuid | uuid da turma |
Parâmetros de URL (query)
| Parâmetro | Descrição |
|---|---|
| search | Busca pelo nome, documento, celular ou e-mail do aluno, pelo curso e pelo nome ou documento da empresa |
| limit | Quantidade máxima de registros |
| per_page | Quantidade de registros por página |
| page | Número da página, quando per_page é informado |
| column e order | Ordenação pela coluna informada, na direção asc ou desc |
Resposta: 200 OK, uma lista de matrículas de alunos na turma (ou lista paginada, com per_page). Campos da aba: uuid, student_name, company_name, status_name, responsible_name, user_create_name, created_at, user_update_name e updated_at. Além deles, a resposta traz os demais dados da matrícula, como class_code e course_name.
curl -X GET "https://api.pedagogo.app/operational/assessments/<uuid-da-turma>/students" \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Accept: application/json"
GET /operational/assessments/{class_uuid}/assessments
Lista as provas da turma, usada na aba Provas. Há uma linha por prova de aluno, criada a partir de um banco de questões.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| class_uuid | uuid da turma |
Parâmetros de URL (query)
| Parâmetro | Descrição |
|---|---|
| training_student_id | id numérico da matrícula do aluno na turma (campo id da listagem de alunos) |
| question_bank_id | id numérico do banco de questões |
| status_id | id do status de prova (veja a lista de status desta página) |
| per_page | Quantidade de registros por página |
| page | Número da página, quando per_page é informado |
| column e order | Ordenação pela coluna informada, na direção asc ou desc |
Resposta: 200 OK, uma lista (ou lista paginada, com per_page). Campos: id, uuid, training_student_id, student_name, question_bank_id, question_bank_title, status_id, status_name, created_at, user_create_name, updated_at e user_update_name. A resposta traz ainda campos de andamento e de resultado da prova do aluno, que não são descritos aqui.
curl -X GET "https://api.pedagogo.app/operational/assessments/<uuid-da-turma>/assessments?per_page=15" \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Accept: application/json"
POST /operational/assessments/{class_uuid}/assessments
Cria as provas dos alunos da turma, usando o banco de questões vinculado ao curso da turma (veja Cursos do banco). A chamada não tem corpo: a API preenche tudo a partir da turma.
Regras aplicadas:
- Um aluno recebe uma prova somente se não tiver prova com situação em andamento (
status_id1). Um aluno que já tem prova concluída ou em outra situação recebe uma nova prova. - As questões são as do banco vinculado ao curso. Se o vínculo estiver com ordem aleatória, as questões são sorteadas; se tiver número de questões, esse número de questões é usado.
- A nota máxima da prova é a soma dos pontos das opções de cada questão selecionada.
- A nota de aprovação e a porcentagem de aprovação do vínculo do curso são copiadas para cada prova criada.
- A API também cria, para cada prova, as questões e as opções que ela contém.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| class_uuid | uuid da turma |
Resposta: 201 Created, com a mensagem Assessments created successfully. A resposta é a mesma quando nenhum aluno precisa de prova. Se o curso da turma não tiver banco de questões vinculado, a resposta é 404, com message igual a Question bank not found.
curl -X POST "https://api.pedagogo.app/operational/assessments/<uuid-da-turma>/assessments" \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Accept: application/json"
GET /operational/training-students-assessments-statuses
Lista os status de prova cadastrados, com id e status (nome do status). Use o id retornado no filtro status_id da listagem de provas. Os ids não são fixos: use sempre o valor devolvido pela consulta.
Parâmetros de URL (query)
| Parâmetro | Descrição |
|---|---|
| per_page | Quantidade de registros por página |
| page | Número da página, quando per_page é informado |
| column e order | Ordenação pela coluna informada, na direção asc ou desc |
Resposta: 200 OK, uma lista de objetos com id e status.