> ## Documentation Index
> Fetch the complete documentation index at: https://docs.toolzz.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

## Parâmetros

<ParamField query="first_student_id" type="int" required>
  ID do primeiro aluno a ser comparado.
</ParamField>

<ParamField query="second_student_id" type="int" required>
  ID do segundo aluno a ser comparado.
</ParamField>

<ParamField query="test_name" type="string" required>
  Nome da avaliação que será utilizada para a comparação entre os alunos.
</ParamField>

<ParamField query="course_id" type="int" required>
  Identificador do curso no qual a avaliação foi vinculada.
</ParamField>

<Note>Para utilizar este recurso, é necessário possuir a feature "Provas Classificatórias" ativa na plataforma.</Note>

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

* **Token de Acesso** `obrigatório`: Certifique-se de possuir um token de autenticação válido antes de prosseguir.
* **first\_student\_id**`obrigató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.

<ResponseField name="test_id" type="number">
  Unique identifier for the test.
</ResponseField>

<ResponseField name="test_name" type="string">
  Name of the test.
</ResponseField>

<ResponseField name="first_student_score" type="number">
  Score of the first student.
</ResponseField>

<ResponseField name="second_student_score" type="number">
  Score of the second student.
</ResponseField>

<ResponseField name="first_student" type="object">
  Information of the first student.

  <Expandable title="properties">
    <ResponseField name="id" type="number">
      Unique identifier for the first student.
    </ResponseField>

    <ResponseField name="name" type="string">
      Name of the first student.
    </ResponseField>

    <ResponseField name="email" type="string">
      Email of the first student.
    </ResponseField>

    <ResponseField name="answers" type="array">
      List of answers provided by the first student.

      <Expandable title="properties">
        <ResponseField name="question_id" type="number">
          Unique identifier for the question.
        </ResponseField>

        <ResponseField name="question" type="string">
          The question asked.
        </ResponseField>

        <ResponseField name="answer" type="string">
          The answer provided by the student.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="second_student" type="object">
  Information of the second student.

  <Expandable title="properties">
    <ResponseField name="id" type="number">
      Unique identifier for the second student.
    </ResponseField>

    <ResponseField name="name" type="string">
      Name of the second student.
    </ResponseField>

    <ResponseField name="email" type="string">
      Email of the second student.
    </ResponseField>

    <ResponseField name="answers" type="array">
      List of answers provided by the second student.

      <Expandable title="properties">
        <ResponseField name="question_id" type="number">
          Unique identifier for the question.
        </ResponseField>

        <ResponseField name="question" type="string">
          The question asked.
        </ResponseField>

        <ResponseField name="answer" type="string">
          The answer provided by the student.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

## 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.