Contents x
- Developers
- Getting Started
- REST API Reference
- Using Cirrus REST API
- Users
- Hierarchies (Groups)
- Collections
- Assessments
- Scheduling
- Attempts
- Marking Settings
- Candidate Review Sessions
- Results
- Webhooks
- Change log
- Integrations
- LTI
- Single Sign-On
Delete invigilators from schedule
- Updated on 01 Jul 2021
- 1 Minute to read
- Contributors
Article summary
Did you find this summary helpful?
Thank you for your feedback
Delete invigilators from schedule
DELETE /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,userexternalidexample1"]
JSON
Sample successfull Response
{
"Content": {
"SuccessfullyRemoved": [
"13081986"
],
"Errors": []
},
"Success": true,
"Errors": null
}
JSON
Sample unsuccessfull Response
{
"Content": {
"SuccessfullyRemoved": [],
"Errors": [
{
"UserExtId": "89999",
"Code": 319,
"Error": "User has not been added as invigilator of this schedule"
}
]
},
"Success": true,
"Errors": null
}
JSON
Responses
Code | Description |
---|---|
200 | Successful operation |
200 | 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 302: Schedule is archived 305: Schedule is finished 319: User has not been added as invigilator of this schedule |
403 | Not allowed to use external API |
500 | Internal server error |
Was this article helpful?
Thank you for your feedback! Our team will get back to you
How can we improve this article?
Your feedback
Comment
Comment (Optional)
Character limit : 500
Please enter your comment
Email (Optional)
Email
Please enter a valid email