Add candidate review session
  • 15 Dec 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Add candidate review session

  • Dark
    Light
  • PDF

Article summary

Create candidate review session

POST /api/v1/integrations/external/review-sessions

NameData TypeDescription
Content-type:application/jsonfor all requests
Authorization:EAPI {token}for all requests

Body Parameters

Parameters indicated with a * are mandatory

Name
Data Type
Description
*ExternalIdString(60)Review session external id
*AssessmentExtIdString(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
*ScheduleExtIdString(60)Either ScheduleExt or AssessmentExtid is mandatory. When using ScheduleExtId, it will create candidate review sessions for this specific schedule (ADVISED)
TitleString(60)Custom title if not provided, it will pick up the title for from the schedule
OwnerString(60)Review session creator username
ReviewPeriodModeString(60)Review window mode:
ALWAYS
TIME_SPAN
StartDateDateTimeOnly use/mandatory if ReviewPeriodMode is set to 'TIME_SPAN'
EndDateDateTimeOnly use/mandatory if ReviewPeriodMode is set to 'TIME_SPAN'
UseKeycodeBooleanKeycode is used
UsePinBooleanReview session external id
PinString(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

CodeDescription
200Successful operation
403Not allowed to use external API
400Possible 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
500Internal server error


Was this article helpful?