Comparativo de resultados de uma prova classificatória

Este endpoint da API permite comparar os resultados de uma prova classificatória entre dois alunos no Toolzz LMS.

GET /api/reports/classification/compare-test-results

Comparativo de resultados de uma prova classificatória

cURL

curl --request GET \
  --url https://kong.api.toolzz.com.br/api/reports/classification/compare-test-results

200

{
  "test_id": 123,
  "test_name": "<string>",
  "first_student_score": 123,
  "second_student_score": 123,
  "first_student": {
    "id": 123,
    "name": "<string>",
    "email": "<string>",
    "answers": [
      {
        "question_id": 123,
        "question": "<string>",
        "answer": "<string>"
      }
    ]
  },
  "second_student": {
    "id": 123,
    "name": "<string>",
    "email": "<string>",
    "answers": [
      {
        "question_id": 123,
        "question": "<string>",
        "answer": "<string>"
      }
    ]
  }
}

Parâmetros

first_student_id · int · required

ID do primeiro aluno a ser comparado.

second_student_id · int · required

ID do segundo aluno a ser comparado.

test_name · string · required

Nome da avaliação que será utilizada para a comparação entre os alunos.

course_id · int · required

Identificador do curso no qual a avaliação foi vinculada.

Para utilizar este recurso, é necessário possuir a feature “Provas Classificatórias” ativa na plataforma.

Antes de utilizar este endpoint, certifique-se de possuir os seguintes parâmetros disponíveis:

• Token de Acesso obrigatório: Certifique-se de possuir um token de autenticação válido antes de prosseguir.
• first_student_idobrigatório: id do primeiro aluno a ser comparado.
• seconde_student_id obrigatório: id do segundo aluno a ser comparado.
• test_name obrigatório: Nome da avaliação que será utilizada para a comparação entre os alunos.
• course_id obrigatório: Identificador do curso no qual a avaliação foi vinculada.

Descrição da Resposta

Abaixo está um exemplo da resposta retornada por este endpoint.

test_id · number

Unique identifier for the test.

test_name · string

Name of the test.

first_student_score · number

Score of the first student.

second_student_score · number

Score of the second student.

first_student · object

Information of the first student.

Show properties

id · number

Unique identifier for the first student.

name · string

Name of the first student.

email · string

Email of the first student.

answers · array

List of answers provided by the first student.

Show properties

question_id · number

Unique identifier for the question.

question · string

The question asked.

answer · string

The answer provided by the student.

second_student · object

Information of the second student.

Show properties

id · number

Unique identifier for the second student.

name · string

Name of the second student.

email · string

Email of the second student.

answers · array

List of answers provided by the second student.

Show properties

question_id · number

Unique identifier for the question.

question · string

The question asked.

answer · string

The answer provided by the student.

Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido através do cabeçalho de autorização (Authorization) da requisição. A API é protegida por outras medidas de segurança para garantir a proteção dos dados dos usuários.