Create candidate review session
POST /api/v1/integrations/external/review-sessions
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 |
| *ScheduleExtId | String(60) | Either ScheduleExt or AssessmentExtid is mandatory. When using ScheduleExtId, it will create candidate review sessions for this specific schedule (ADVISED) |
| Title | String(60) | Custom title if not provided, it will pick up the title for from the schedule |
| Owner | String(60) | Review session creator username |
| ReviewPeriodMode | String(60) | Review window mode: ALWAYS TIME_SPAN |
| StartDate | DateTime | Only use/mandatory if ReviewPeriodMode is set to 'TIME_SPAN' |
| EndDate | DateTime | Only use/mandatory if ReviewPeriodMode is set to 'TIME_SPAN' |
| UseKeycode | Boolean | Keycode is used |
| UsePin | Boolean | Review session external id |
| Pin | String(60) | If Usepin is false, it's set to null or empty. If no Pin is defined, it will be automaticly created |
Sample Request URL
https://api.cirrusplatform.com/api/v1/integrations/external/review-sessions
Sample Request
{
"ExternalId": "CR123",
"AssessmentExtId": null,
"ScheduleExtId": "oaOXkn",
"Title": "Candidate review example #1",
"Owner": "ExampleUser",
"ReviewPeriodMode": "TIME_SPAN",
"StartDate": "2022-12-15T12:25:00Z",
"EndDate": "2022-12-15T14:25:00Z",
"UseKeycode": true,
"UsePin": true,
"Pin": null
}
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: 1103: Review session owner hasn't been defined in external API settings in Cirrus app 1104: Review session request data is invalid 1106: Review session with the same ExternalId is already exists 301: Schedule has not been found 310: Schedule has not yet begun 1100: ReviewSessionExternalId can not be null or empty 1112: User does not have permissions to view review sessions 1124: Assessment is not found 1109: Started schedule(s) based on the assessment not found 1125: Keycodes are disabled by global settings |
| 500 | Internal server error |