Contents x
    Update Candidate review session info
    • 15 Dec 2022
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Update Candidate review session info

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

    Update candidate review session info

    PATCH /api/v1/integrations/external/review-sessions/{externalId}
    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
    TitleString(60)Review session external id
    ReviewPeriodModeString(60)Review window mode:
    ALWAYS
    TIME_SPAN
    StartDateDateTimeReview session external id
    EndDateDateTimeReview session external id
    UseKeycodeBooleanKeycode is used
    UseLockDownBrowserBooleanUse of lockdown browser
    UsePinBooleanReview session external id
    PinString(60)If Usepin is false, it's set to null, otherwise a pin will shown
    NavigationTypeString(60)Possible values:
    CANDIDATE_DELIVERY
    ORIGINAL_FORM
    OverviewOptionsString(60)Overview options
    ShowGradeBooleanShow grade on dashboard and overview
    ShowPercentageToPassBooleanShow perectage to pass on dashboard an overview
    ShowResultOutcomeBooleanShow result outcome on dashboard and overview
    ResultsOptionsCandidate review options
    ResultsOptions.ShowSummaryBooleanShow summary information
    ResultsOptions.ShowDetailedBooleanShow detailed information
    ResultsOptions.ScoreReportWithSubjectsBooleanShow score report based with subjectives
    ResultsOptions.ScoreReportWithObjectivesBooleanShow score report based on Learning objectives
    When ScoreReportWithSubjectsScore is false: ReportWithObjectives should be false
    ResultsOptions.ScoreReportWithTopicsBooleanShow score report based on topics
    ResultsOptions.ShowMarkingSchemeBooleanShow markingscheme if set
    When ShowDetailed is false: ShowMarkingScheme should be false.
    ResultsOptions.ShowAnnotationsBooleanShow annotations/feedback from markers
    When ShowSummary and ShowDetailedResult is false: ShowAnnotations should be false.
    ResultsOptions.FeedbackString(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

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