StartExam API

Register Program Employees

Method registers or unregisters employees for a given program.

Request Information

Scheme

POST https://api.startexam.com/v1/program/employees

URI Parameters

None

Body Parameters

Json with a RegisterProgramEmployeesQuery:

  • ProgramId - Program identifier, guid from StartExam.
  • ProgramExternalId - Program external identifier. Pass your own string ID from integrated system rather than guid from StartExam for easier integration (optional).
  • ModuleTestsScope - pass all to apply action for all tests in a program, or pass selected to apply action only for selected tests in a program.
  • ModuleTests - identifiers of specific module tests, guids from StartExam. Used only for ModuleTestsScope = selected and manual program mode.
  • RegisterEmployees - Identifiers of employees to register. One request must not contain more than 500 employees to register.
  • UnregisterEmployees - Identifiers of employees to unregister. One request must not contain more than 500 employees to unregister.

Request Example

Example 1: all scope: register / unregister for all tests at once.
Example 2: selected scope: register / unregister for specified tests.

POST https://api.startexam.com/v1/program/employees 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: 235
Date: Fri, 22 Oct 2021 12:15:40 GMT

{
  "programId": "90b9e065-ceba-47be-b8c5-e9e84afbd84d",
  "programExternalId": null,
  "moduleTestsScope": "all",
  "moduleTests": null,
  "registerEmployees": [
    "10943",
    "10948",
    "10924"
  ],
  "unregisterEmployees": []
}
POST https://api.startexam.com/v1/program/employees 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: 398
Date: Fri, 22 Oct 2021 12:15:40 GMT

{
  "programId": "73c45d95-266c-4df1-94aa-2f7d253dc494",
  "programExternalId": null,
  "moduleTestsScope": "selected",
  "moduleTests": [
    "ecc24389-b968-430b-a5b9-cd70d9e708aa",
    "6ea5a99b-f62f-45d3-8bdf-862ac6d1a382",
    "79d4bfba-fabc-4c7f-ad20-4257e8f05afb"
  ],
  "registerEmployees": [
    "10536",
    "10605",
    "10581",
    "10576",
    "10947"
  ],
  "unregisterEmployees": []
}

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

Method returns operation results:

  • EmployeesRegistered - number of new employees added to the program.
  • AttemptsRegistered - number of attempts created.
  • EmployeesUnregistered - number of employees removed from the program.
  • AttemptsUnregistered - number of attempts removed.
  • TotalEmployeesInProgram - total number of employees in the program after operation.

Response Example

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

{
  "employeesRegistered": 3,
  "attemptsRegistered": 12,
  "employeesUnregistered": 0,
  "attemptsUnregistered": 0,
  "totalEmployeesInProgram": 100
}

Try Method