Method registers or unregisters employees for a given program.
POST https://api.startexam.com/v1/program/employees
None
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.
all
scope: register / unregister for all tests at once.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: 289
Date: Wed, 24 Apr 2024 15:43:12 GMT
{
"programId": "559fada8-4f83-4f1b-8673-c34c43543d64",
"programExternalId": null,
"moduleTestsScope": "all",
"moduleTests": null,
"registerEmployees": [
"10669",
"10811",
"10560",
"10825",
"10662"
],
"unregisterEmployees": [
"11851",
"11816"
]
}
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: 297
Date: Wed, 24 Apr 2024 15:43:12 GMT
{
"programId": "49eefa75-cbff-4a9f-83e0-de4a00f6d6d4",
"programExternalId": null,
"moduleTestsScope": "selected",
"moduleTests": [
"6946325e-93b4-49e9-a9f7-e16fce668f67"
],
"registerEmployees": [
"10837",
"10717",
"10898",
"10851"
],
"unregisterEmployees": []
}
Date and Authorization headers are constructed in the standard way.
200 OK, 400 Bad Request, etc. according the response processing guide.
Json.
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.
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 150
{
"employeesRegistered": 5,
"attemptsRegistered": 10,
"employeesUnregistered": 2,
"attemptsUnregistered": 4,
"totalEmployeesInProgram": 98
}