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

    Add candidates to candidate review session

    • Updated on 15 Dec 2022
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Get schedule info

    PUT /api/v1/integrations/external/review-sessions/{externalId}/results/add
    NameData TypeDescription
    Content-type:application/jsonfor all requests
    Authorization:EAPI {token}for all requests

    Request Parameters

    Parameters indicated with a * are mandatory

    ParameterTypeDescription
    externalIdString(60)Schedule external id

    Body Parameters

    Parameters indicated with a * are mandatory

    Name
    Data Type
    		Description
    *CandidateExtIdString(60)candidate userid
    ScheduleExtIdString(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

    CodeDescription
    200Successful operation
    403Not allowed to use external API
    400Possible 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
    500Internal server error
    Was this article helpful?
    What's Next