Add invigilators to schedule
- 18 Oct 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Add invigilators to schedule
- Updated on 18 Oct 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Add invigilators to schedule
PUT /schedule/{externalId}/invigilators
Header
| Name | Data Type | Description |
|---|---|---|
| Content-type: | application/json | for all requests |
| Authorization: | EAPI {token} | for all requests |
Request Parameters
Parameters indicated with a * are mandatory
| Parameter | Type | Description | max length |
|---|---|---|---|
| externalId* | String | The external ID of the schedule |
Request Parameters (for message body)
Parameters indicated with a * are mandatory
| Parameter | Type | Description | max length |
|---|---|---|---|
| Array* | String | External ids of invigilators |
Sample Body Request
["userexternalidexample1","userexternalidexample2"]
Sample successfull Response
{
"Content": {
"SuccessfullyAdded": [
"13081986",
"14081986"
],
"Errors": []
},
"Success": true,
"Errors": null
}
Sample unsuccessfull Response
{
"Content": {
"SuccessfullyAdded": [],
"Errors": [
{
"UserExtId": "89999",
"Code": 318,
"Error": "User does not have permissions to be invigilator"
}
]
},
"Success": true,
"Errors": null
}
Responses
| Code | Description |
|---|---|
| 200 | Successful operation |
| 400 | Possible errors: 100: Request body can not be null or empty 200: Request does not contains any valid user external ids 300: ScheduleExternalId can not be null or empty 301: Schedule has not been found 302: Schedule is archived 305: Schedule is finished 318: User does not have permissions to be invigilator |
| 403 | Not allowed to use external API |
| 500 | Internal server error |
Was this article helpful?