StartExam API

Register Employees

Method registers employees for a test and returns identifiers that can be used to start the test.

Request Information

Scheme

POST https://api.startexam.com/v2/employees-participants

URI Parameters

None

Body Parameters

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.
  • proctoring - enable proctoring (applicable only for accounts with enabled proctoring)
  • doNotCreateIfExist - do not create new registration if employee has been already registered for center and test
  • tests - from 1 to 10 test identifiers, Guid.
  • employees - from 1 to 500 employees identifiers.

Request Example

POST https://api.startexam.com/v2/employees-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: 349
Date: Thu, 06 Oct 2022 14:15:16 GMT

{
  "center": "mycenter",
  "validFrom": "2022-10-06T00:00:00Z",
  "validTill": "2022-10-16T23:59:59Z",
  "proctoring": false,
  "doNotCreateIfExist": false,
  "tests": [
    "20508276-92ff-4e86-9076-fe5677650be6"
  ],
  "employees": [
    {
      "id": "willis74"
    },
    {
      "id": "knightly32"
    },
    {
      "id": "covey77"
    }
  ]
}

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

Identifiers of registered participants (sessions for employees).

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}

Response Example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 166

{
  "participantIds": [
    "f1335d89-8b1d-401f-b215-bef71d7dab66",
    "b3316565-1000-461b-ab99-d479166c8c6e",
    "c1b9c8cc-0956-4ccc-9923-ebe32db2d078"
  ]
}

To redirect the first participant (willis74) to the assessment you can use URL:

https://go.startexam.com/mycenter#participant/f1335d89-8b1d-401f-b215-bef71d7dab66

Try Method