StartExam API

Get Participants Results

Method returns results of the test participants for the specified participant ids.

Request Information

Scheme

GET https://api.startexam.com/v1/participants?participantId={participantId}

URI Parameters

  • participantId - participant id. The value can contain several ids separated by ','.

Body Parameters

None.

Request Example

GET https://api.startexam.com/v1/participants?participantId=3bb921c8-6b25-456b-9959-e81183f00a90,45c264ce-9356-4dff-956f-7767fa3ebca4 HTTP/1.1
Host: api.startexam.com
Accept: application/json; charset=utf-8
Authorization: SharedKey 99:f52JP7GQd0xqrBzMO1NWTNVGzLENymgdUXu/Ie++NX4=
Date: Thu, 30 Jan 2014 21:45:57 GMT

Date and Authorization headers are constructed in the standard way.

Response Information

HTTP status code

200 OK, 400 Bad Request, etc. according the response processing guide.

Content-Type

Json.

Content

Test session results for participants according the requested participant identifiers.
If a participant hasn't opened a link and hasn't started the test there will be no result for her.
Every returned participant can have one or more sessions. Sessions and results are grouped if the personal data for two sessions is absolutely equal.
Every session can be finished or not and depending on this some fields (elapsedTime, score, maxScore, percent) can present or not in a response.

Response Example

{
  "participants": [
    {
      "id": "3bb921c8-6b25-456b-9959-e81183f00a90",
      "data": [
        {
          "key": "f1094d46-fe61-49fc-89a7-d534e9a2c013",
          "value": "000000000"
        },
        {
          "key": "Email",
          "value": "lennon@gmail.com"
        },
        {
          "key": "FirstName",
          "value": "John"
        },
        {
          "key": "LastName",
          "value": "Lennon"
        }
      ],
      "sessions": [
        {
          "id": "75858770-be57-42da-962e-2a961dcb8f76",
          "testID": "cbcfa2e7-bc49-4f9d-81fd-8abc8c41a394",
          "started": "2013-02-08T11:01:41Z",
          "isFinished": true,
          "elapsedTime": "01:00:11",
          "score": 21.0,
          "maxScore": 90.0,
          "percent": 23.33
        },
        {
          "id": "b5dcf0b3-0714-49b5-9a46-e85444eceb40",
          "testID": "2eca1305-a99f-4f43-bdb9-ba93e5ca86af",
          "started": "2013-02-09T11:58:09Z",
          "isFinished": false
        }
      ]
    },
    {
      "id": "45c264ce-9356-4dff-956f-7767fa3ebca4",
      "data": [
        {
          "key": "f1094d46-fe61-49fc-89a7-d534e9a2c013",
          "value": "999999999"
        },
        {
          "key": "Email",
          "value": "paulmccartney@hotmail.com"
        },
        {
          "key": "FirstName",
          "value": "Paul"
        },
        {
          "key": "LastName",
          "value": "McCartney"
        }
      ],
      "sessions": [
        {
          "id": "8eb6b3f5-71ec-4a44-9f15-467fb4992835",
          "testID": "2eca1305-a99f-4f43-bdb9-ba93e5ca86af",
          "started": "2013-09-15T07:55:41Z",
          "isFinished": true,
          "elapsedTime": "02:00:02",
          "score": 70.0,
          "maxScore": 129.0,
          "percent": 54.26
        },
        {
          "id": "6d5256e2-4ce2-4a94-8144-e658fb344ff9",
          "testID": "cbcfa2e7-bc49-4f9d-81fd-8abc8c41a394",
          "started": "2013-09-17T10:10:45Z",
          "isFinished": true,
          "elapsedTime": "00:59:56",
          "score": 51.0,
          "maxScore": 90.0,
          "percent": 56.67
        }
      ]
    }
  ]
}

Participant data with type Image will be returned in base64 data URI scheme format.
Supported image types: image/jpeg, image/png, image/gif. Value example (red dot png image): 

data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==

Try Method