Get schedule info
PUT /api/v1/integrations/external/review-sessions/{externalId}/results/add
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 |
|---|---|---|
| externalId | String(60) | Schedule external id |
Body Parameters
Parameters indicated with a * are mandatory
| Name | Data Type |
Description |
|---|---|---|
| *CandidateExtId | String(60) | candidate userid |
| ScheduleExtId | String(60) | Schedule external id, only needed if you have candidate review setup for assessment (instead of schedules) and if you want to define a specific schedule |
Sample Request URL
https://api.cirrusplatform.com/api/v1/integrations/external/review-sessions/EXT_123/results/add
Sample request
{
"CandidateResults": [
{
"CandidateExtId": "ext1"
},
{
"CandidateExtId": "ext2",
"ScheduleExtId": "s_ext2"
}
]
}
Sample successfull Response
{
"Content": {
"SuccessfullyAdded": [
{
"CandidateExtId": "george"
}
],
"Errors": []
},
"Success": true,
"Errors": null
}
Sample unsuccessfull Response
{
"Content": {
"SuccessfullyAdded": [],
"Errors": [
{
"CandidateExtId": "brad",
"Code": 1127,
"Error": "Candidate result(s) already added to the review session"
},
{
"CandidateExtId": "brad",
"Code": 1128,
"Error": "Candidate result(s) already added to an ongoing review session"
},
{
"CandidateExtId": "peter",
"Code": 202,
"Error": "User has not been found"
}
]
},
"Success": true,
"Errors": null
}
Response codes
| Code | Description |
|---|---|
| 200 | Successful operation |
| 403 | Not allowed to use external API |
| 400 | Possible error codes: 1100: ReviewSessionExternalId can not be null or empty 200: Request does not contains any valid user external ids 201: CandidateExternalId can not be null or empty 1101: Review session has not been found 1107: Review session has ended 1108: Review session is archived 1126: Published candidate result not found 1127: Candidate result(s) already added to the review session 1128: Candidate result(s) already added to an ongoing review session |
| 500 | Internal server error |