Method registers participants for a test and returns identifiers that can be used to start the test.
POST https://api.startexam.com/v1/participants
None
Json with the RegisterParticipantsQuery, see details and example below.
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.
tests
- from 1 to 10 test identifiers, Guid.
participants
- from 1 to 1000 participants to register. Each participant must contain a set of
personal data elements (key-value pairs) with the same keys and custom values. Keys can be retrieved
on the test Profile page. The values must be valid for the corresponding
profile fields and its rules.
POST https://api.startexam.com/v1/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: 971
Date: Thu, 16 Jan 2014 07:38:44 GMT
{
"center": "mycenter",
"validFrom": "2014-01-16T00:00:00Z",
"validTill": "2014-01-31T23:59:59Z",
"tests": [
"2eca1305-a99f-4f43-bdb9-ba93e5ca86af"
],
"participants": [
{
"data": [
{
"key": "FirstName",
"value": "John"
},
{
"key": "LastName",
"value": "Lennon"
},
{
"key": "Email",
"value": "lennon@gmail.com"
},
{
"key": "f1094d46-fe61-49fc-89a7-d534e9a2c013",
"value": "000000000"
}
]
},
{
"data": [
{
"key": "FirstName",
"value": "Paul"
},
{
"key": "LastName",
"value": "McCartney"
},
{
"key": "Email",
"value": "paulmccartney@hotmail.com"
},
{
"key": "f1094d46-fe61-49fc-89a7-d534e9a2c013",
"value": "999999999"
}
]
}
]
}
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 depending on a Accept header value according the response processing guide.
Identifiers of registered participants.
Use the URL mask below to construct a unique link for employee 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: 121
{
"participantIds": [
"aafc976e-61bc-404f-87ed-5e9f4625cb39",
"582f3bf4-8881-45b6-a5ac-d0af4e6b2a87"
]
}
To redirect the first participant (John Lennon) to the assessment you can use URL:
https://go.startexam.com/mycenter#participant/aafc976e-61bc-404f-87ed-5e9f4625cb39