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: 235
Date: Thu, 02 May 2024 19:34:03 GMT
{
"programId": "e1540366-35ba-433e-b7df-f1e00319fee1",
"programExternalId": null,
"moduleTestsScope": "all",
"moduleTests": null,
"registerEmployees": [
"10556",
"10795",
"10670"
],
"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: 346
Date: Thu, 02 May 2024 19:34:03 GMT
{
"programId": "23087d7a-6bc8-482c-acf0-cdb383713fb0",
"programExternalId": null,
"moduleTestsScope": "selected",
"moduleTests": [
"3221ec25-e7be-4947-bdd1-aece897669fb",
"abcde896-e26a-49e7-b1b0-13facea15286",
"7ed69139-70b4-4077-b7c0-365de32e449f"
],
"registerEmployees": [
"10758"
],
"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: 151
{
"employeesRegistered": 3,
"attemptsRegistered": 12,
"employeesUnregistered": 0,
"attemptsUnregistered": 0,
"totalEmployeesInProgram": 100
}