Compare Test Results

Endpoint used to compare the results of a classification test between two students in Toolzz LMS.

Request Example

curl --request GET \
  --url 'https://kong.api.toolzz.com.br/api/reports/classification/compare-test-results?first_student_id=123&second_student_id=456&test_name=test&course_id=789' \
  --header 'Authorization: Bearer <token>'

Response Example

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

Request description

Access Token

Parameter	Type	Description	Required
`Authorization`	String	Access token (“Bearer” must be before the token)	Yes

URL Parameters (Query)

Parameter	Type	Description	Required
`first_student_id`	int	ID of the first student to be compared.	Yes
`second_student_id`	int	ID of the second student to be compared.	Yes
`test_name`	string	Name of the assessment that will be used for comparison between students.	Yes
`course_id`	int	Course identifier in which the assessment was linked.	Yes

Note: To use this resource, it is necessary to have the “Classification Tests” feature active on the platform.

Response description

Key	Type	Description
`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.
`first_student.id`	number	Unique identifier for the first student.
`first_student.name`	string	Name of the first student.
`first_student.email`	string	Email of the first student.
`first_student.answers`	array	List of answers provided by the first student.
`first_student.answers.question_id`	number	Unique identifier for the question.
`first_student.answers.question`	string	The question asked.
`first_student.answers.answer`	string	The answer provided by the student.
`second_student`	object	Information of the second student.
`second_student.id`	number	Unique identifier for the second student.
`second_student.name`	string	Name of the second student.
`second_student.email`	string	Email of the second student.
`second_student.answers`	array	List of answers provided by the second student.
`second_student.answers.question_id`	number	Unique identifier for the question.
`second_student.answers.question`	string	The question asked.
`second_student.answers.answer`	string	The answer provided by the student.

Security

To access this endpoint, it is necessary to send a valid access token through the authorization header (Authorization) of the request. Additionally, the API is protected by other security measures to safeguard user data.