Update Candidate review session info

  • Published on Dec 15, 2022
  • 1 minute(s) read
Prev Next

Update candidate review session info

PATCH /api/v1/integrations/external/review-sessions/{externalId}

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
Title String(60) Review session external id
ReviewPeriodMode String(60) Review window mode:
ALWAYS
TIME_SPAN
StartDate DateTime Review session external id
EndDate DateTime Review session external id
UseKeycode Boolean Keycode is used
UseLockDownBrowser Boolean Use of lockdown browser
UsePin Boolean Review session external id
Pin String(60) If Usepin is false, it's set to null, otherwise a pin will shown
NavigationType String(60) Possible values:
CANDIDATE_DELIVERY
ORIGINAL_FORM
OverviewOptions String(60) Overview options
ShowGrade Boolean Show grade on dashboard and overview
ShowPercentageToPass Boolean Show perectage to pass on dashboard an overview
ShowResultOutcome Boolean Show result outcome on dashboard and overview
ResultsOptions Candidate review options
ResultsOptions.ShowSummary Boolean Show summary information
ResultsOptions.ShowDetailed Boolean Show detailed information
ResultsOptions.ScoreReportWithSubjects Boolean Show score report based with subjectives
ResultsOptions.ScoreReportWithObjectives Boolean Show score report based on Learning objectives
When ScoreReportWithSubjectsScore is false: ReportWithObjectives should be false
ResultsOptions.ScoreReportWithTopics Boolean Show score report based on topics
ResultsOptions.ShowMarkingScheme Boolean Show markingscheme if set
When ShowDetailed is false: ShowMarkingScheme should be false.
ResultsOptions.ShowAnnotations Boolean Show annotations/feedback from markers
When ShowSummary and ShowDetailedResult is false: ShowAnnotations should be false.
ResultsOptions.Feedback String(60) Possible values:
ON_ALTERNATIVES
ON_QUESTIONS
NO_FEEDBACK
When ShowDetailedResult is false, only NoFeedback allowed

Sample Request URL

https://api.cirrusplatform.com/api/v1/integrations/external/review-sessions/CR123

Sample Request

{
    "Title": "TEST patch",
    "ReviewPeriodMode": "TIME_SPAN",
    "StartDate": "2022-12-15T11:25:00Z",
    "EndDate": "2022-12-15T12:25:00Z",
    "UseKeycode": true,
    "UseLockDownBrowser": false,
    "UsePin": true,
    "Pin": 1234,
    "NavigationType": "CANDIDATE_DELIVERY",
    "ResultsOptions": {
        "ShowSummary": true,
        "ShowDetailed": true,
        "ScoreReportWithSubjects": false,
        "ScoreReportWithObjectives": false,
        "ScoreReportWithTopics": false,
        "ShowMarkingScheme": false,
        "ShowAnnotations": false,
        "Feedback": "NO_FEEDBACK"
    },
    "OverviewOptions": {
        "ShowGrade": false,
        "ShowPercentageToPass": true,
        "ShowResultOutcome": true
    }
}

Sample succesfull response

{
"Success": true,
"Errors": null
}

Response codes

Code Description
200 Successful operation
403 Not allowed to use external API
400 Possible error codes:
1101: Review session has not been found
1104: Review session request data is invalid
1105: Review session is activated
1125: Keycodes are disabled by global settings
1132: Cannot change viewed review session
1133: Can only change review window in active review session
500 Internal server error