Method registers participants for a test and returns identifiers that can be used to start the test.
POST https://api.startexam.com/v2/participants
None
Json.
center
- center unique name. The value can be retrieved from the center details page.
validFrom
- session link activation time, UTC, ISO 8601.
validTill
- session link expiration time, UTC, ISO 8601.
proctoring
- enable proctoring (applicable only for accounts with enabled proctoring)
tests
- from 1 to 10 test identifiers, Guid.
participants
- from 1 to 1000 participants to register. Each participant must contain a set of
name-value pairs with personal data. Field names and validation rules
can be found and changed in test settings.
POST https://api.startexam.com/v2/participants HTTP/1.1
Host: api.startexam.com
Accept: application/json; charset=utf-8
Authorization: SharedKey 99:f52JP7GQd0xqrBzMO1NWTNVGzLENymgdUXu/Ie++NX4=
Content-Type: application/json; charset=utf-8
Content-Length: 974
Date: Thu, 25 Apr 2024 17:44:55 GMT
{
"center": "mycenter",
"validFrom": "2024-04-25T00:00:00Z",
"validTill": "2024-05-05T23:59:59Z",
"proctoring": false,
"tests": [
"e2652fb4-0f0a-4339-8e03-c3eb6fbda8c0"
],
"participants": [
{
"data": [
{
"name": "First Name",
"value": "John"
},
{
"name": "Last Name",
"value": "Lennon"
},
{
"name": "Email",
"value": "lennon@gmail.com"
},
{
"name": "My Custom Field Name",
"value": "000000001"
}
]
},
{
"data": [
{
"name": "First Name",
"value": "Paul"
},
{
"name": "Last Name",
"value": "McCartney"
},
{
"name": "Email",
"value": "paulmccartney@outlook.com"
},
{
"name": "My Custom Field Name",
"value": "000000002"
}
]
}
]
}
Date and Authorization headers are constructed in the standard way.
Value of participant data with type Image
must be sent in base64
data URI scheme format.
Supported image types: image/jpeg, image/png, image/gif. Well formatted value example (red dot png image):
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==
200 OK, 400 Bad Request, etc. according the response processing guide.
Json.
Identifiers of registered participants.
Use the URL mask below to construct a unique link for participant and redirect him to his exam:
https://go.startexam.com/{center}#participant/{id}
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 116
{
"participantIds": [
"817dc414-240d-424b-a46b-f61c12bc8de4",
"88e55ce6-5ed1-4ed4-81ff-53125b24b76c"
]
}
To redirect the first participant (John Lennon) to the assessment you can use URL:
https://go.startexam.com/mycenter#participant/817dc414-240d-424b-a46b-f61c12bc8de4