Add candidates to schedule
- 30 Jun 2021
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Add candidates to schedule
- Updated on 30 Jun 2021
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Add candidates to schedule
PUT /schedule/{externalId}/candidates
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": {
"AddedCandidateExternalIds": [],
"NotFoundUserExternalIds": [],
"AlreadyAddedCandidateExternalIds": [
"cirrus_user_ext_id1"
]
},
"Success": true,
"Errors": null
}
Responses
| Code | Description |
|---|---|
| 200 | Successful operation |
| 400 | Possible errors: Schedule hasn't been found by external id No external ids have been provided No users were found by external ids Scheduler hasn’t been set in External API settings Selected scheduler no longer has permission to create, update and delete schedules |
| 403 | Not allowed to use external API |
| 500 | Internal server error |
Was this article helpful?