Contents x
    Get review session info
    • 15 Dec 2022
    • 2 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Get review session info

    • Updated on 15 Dec 2022
    • 2 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Get review session info

    GET /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
    *externalIdString(60)Review session external id

    Response Parameters

    Parameters indicated with a * are mandatory

    Name
    Data Type
    		Description
    ExternalIdString(60)Review session external id
    AssessmentExtIdString(60)Assessment external id
    ScheduleExtIdString(60)Schedule external id (not set for review sessions based on assessment)
    ResultsArrayCandidate results info
    Results.CandidateExtIdString(60)Candidate external id
    Results.ScheduleExtIdString(60)Schedule external id
    Results.ScheduleTitleString(60)Schedule title
    Results.ScheduleGroupNameString(60)Hierarchy
    Results.FirstNameString(60)Candidate first name
    Results.LastNameString(60)Candidate last name
    Results.UserNameString(60)Candidate username
    Results.EmailString(60)Candidate email
    Results.DateOfBirthDateTimeCandidate date of birth
    Results.SpecialNeedsBoolean)True for candidates with special needs
    Results.LabelsArray)Candidate labels
    Results.LastSatDateString(60)Date of last submitted attempt
    Results.PassedStatusString(60)Possible values:
    NOT_SATISFACTORY
    SATISFACTORY
    NOT_SUBMITTED
    VOIDED
    Results.ScoreDecimal)Result score
    Results.PublishedDateDateTimeResult publish date
    Results.IsVisitedString(60)True if candidate viewed the review session
    Results.VisitedDateString(60)Date when candidate viewed the review session
    Results.HasConflictsString(60)True if the same result is added to another ongoing review session
    Results.KeycodeString(60)Result keycode, if empty: null
    Results.GradeString(60)Result grade
    TitleString(60)Review session external id
    HierarchyReview session hierarchy info (set for review sessions based on schedule)
    Hierarchy.ExternalIdString(60)Hierarchy external id
    Hierarchy.FullPathString(60)Hierarchy full path up to root hierarchy
    CodeString(60)Assessment code
    ReviewPeriodModeString(60)Review window mode:
    ALWAYS
    TIME_SPAN
    StartDateDateTimeReview session external id
    EndDateDateTimeReview session external id
    NumOfCandidatesString(60)Review session external id
    StatusString(60)Possible values:
    ACTIVE
    DRAFT
    OwnerString(60)Review session creator username
    IsArchivedString(60)True is review session is archived
    UseKeycodeBooleanKeycode is used
    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
    ResultsOptions.ScoreReportWithTopicsBooleanShow score report based on topics
    ResultsOptions.ShowMarkingSchemeBooleanShow markingscheme if set
    ResultsOptions.ShowAnnotationsBooleanShow annotations/feedback from markers
    ResultsOptions.FeedbackString(60)Possible values:
    ON_ALTERNATIVES
    ON_QUESTIONS
    NO_FEEDBACK
    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
    NavigationTypeString(60)Possible values:
    CANDIDATE_DELIVERY
    ORIGINAL_FORM
    UseLockDownBrowserBooleanUse of lockdown browser
    UsePinBooleanReview session external id
    PinString(60)If Usepin is false, it's set to null, otherwise a pin will shown

    Sample Request URL

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

    Sample Request

    {
    "Content": {
        "ExternalId": "P7N1qK",
        "AssessmentExtId": "iTtL6W",
        "ScheduleExtId": "cIHFyx",
        "Results": [
            {
                "FirstName": "Leonardo",
                "LastName": "DiCaprio",
                "UserName": "leonardo",
                "Email": "dummy@cirrusassessment.com",
                "DateOfBirth": null,
                "Labels": [],
                "CandidateExtId": "leonardo1",
                "ScheduleExtId": "cIHFyx",
                "ScheduleTitle": "Candidate review test 1",
                "ScheduleGroupName": "Arts and Culture",
                "LastSatDate": "2022-12-15T08:38:26.483Z",
                "PassedStatus": "SATISFACTORY",
                "Score": 12.0,
                "Grade": "5,5",
                "PublishedDate": "2022-12-15T08:43:28.502Z",
                "IsVisited": false,
                "VisitedDate": null,
                "HasConflicts": false,
                "SpecialNeeds": true,
                "Keycode": null
            }
        ],
        "Title": "Candidate review test 2",
        "Hierarchy": {
            "ExternalId": 123,
            "FullPath": "University Cirrus / Arts and Culture"
        },
        "Code": "111",
        "ReviewPeriodMode": "TIME_SPAN",
        "StartDate": "2022-12-15T08:42:00Z",
        "EndDate": "2022-12-15T09:45:00Z",
        "NumOfCandidates": 1,
        "Status": "DRAFT",
        "Owner": "CirrusCreator",
        "IsArchived": true,
        "UseKeycode": false,
        "ResultsOptions": {
            "ShowSummary": true,
            "ShowDetailed": true,
            "ScoreReportWithSubjects": true,
            "ScoreReportWithObjectives": true,
            "ScoreReportWithTopics": true,
            "ShowMarkingScheme": true,
            "ShowAnnotations": true,
            "Feedback": "NO_FEEDBACK"
        },
        "OverviewOptions": {
            "ShowGrade": true,
            "ShowPercentageToPass": false,
            "ShowResultOutcome": false
        },
        "NavigationType": "CANDIDATE_DELIVERY",
        "UseLockDownBrowser": false,
        "UsePin": false,
        "Pin": null
    },
    "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.
    500Internal server error
    Was this article helpful?
    What's Next