Remove candidate review session
PUT /api/v1/integrations/external/review-sessions/{externalId}/results/remove
Header
| Name | Data Type | Description |
|---|---|---|
| Content-type: | application/json | for all requests |
| Authorization: | EAPI {token} | for all requests |
Body Parameters
Parameters indicated with a * are mandatory
| Name | Data Type |
Description |
|---|---|---|
| *ExternalId | String(60) | Review session external id |
| *AssessmentExtId | String(60) | Either ScheduleExt or AssessmentExtid is mandatory. When using AssessmentExtid, it will create candidate review sessions for alle related schedules, this could lead up to multiple sessions for candidates |
Sample Request URL
https://api.cirrusplatform.com/api/v1/integrations/external/review-sessions/CR123/results/remove
Sample Request
{
"CandidateResults": [
{
"CandidateExtId": "ext1"
},
{
"CandidateExtId": "ext2",
"ScheduleExtId": "s_ext2"
}
]
}
Sample succesfull response
{
"Content": "CR123",
"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 1126: Published candidate result not found 1129: Candidate result(s) not added to review session 1130: Cannot remove viewed result(s) 1131: Cannot remove all results from review session |
| 500 | Internal server error |