Get review session info
GET /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 |
|---|---|---|
| *externalId | String(60) | Review session external id |
Response Parameters
Parameters indicated with a * are mandatory
| Name | Data Type |
Description |
|---|---|---|
| ExternalId | String(60) | Review session external id |
| AssessmentExtId | String(60) | Assessment external id |
| ScheduleExtId | String(60) | Schedule external id (not set for review sessions based on assessment) |
| Results | Array | Candidate results info |
| Results.CandidateExtId | String(60) | Candidate external id |
| Results.ScheduleExtId | String(60) | Schedule external id |
| Results.ScheduleTitle | String(60) | Schedule title |
| Results.ScheduleGroupName | String(60) | Hierarchy |
| Results.FirstName | String(60) | Candidate first name |
| Results.LastName | String(60) | Candidate last name |
| Results.UserName | String(60) | Candidate username |
| Results.Email | String(60) | Candidate email |
| Results.DateOfBirth | DateTime | Candidate date of birth |
| Results.SpecialNeeds | Boolean) | True for candidates with special needs |
| Results.Labels | Array) | Candidate labels |
| Results.LastSatDate | String(60) | Date of last submitted attempt |
| Results.PassedStatus | String(60) | Possible values: NOT_SATISFACTORY SATISFACTORY NOT_SUBMITTED VOIDED |
| Results.Score | Decimal) | Result score |
| Results.PublishedDate | DateTime | Result publish date |
| Results.IsVisited | String(60) | True if candidate viewed the review session |
| Results.VisitedDate | String(60) | Date when candidate viewed the review session |
| Results.HasConflicts | String(60) | True if the same result is added to another ongoing review session |
| Results.Keycode | String(60) | Result keycode, if empty: null |
| Results.Grade | String(60) | Result grade |
| Title | String(60) | Review session external id |
| Hierarchy | Review session hierarchy info (set for review sessions based on schedule) | |
| Hierarchy.ExternalId | String(60) | Hierarchy external id |
| Hierarchy.FullPath | String(60) | Hierarchy full path up to root hierarchy |
| Code | String(60) | Assessment code |
| ReviewPeriodMode | String(60) | Review window mode: ALWAYS TIME_SPAN |
| StartDate | DateTime | Review session external id |
| EndDate | DateTime | Review session external id |
| NumOfCandidates | String(60) | Review session external id |
| Status | String(60) | Possible values: ACTIVE DRAFT |
| Owner | String(60) | Review session creator username |
| IsArchived | String(60) | True is review session is archived |
| UseKeycode | Boolean | Keycode is used |
| 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 |
| ResultsOptions.ScoreReportWithTopics | Boolean | Show score report based on topics |
| ResultsOptions.ShowMarkingScheme | Boolean | Show markingscheme if set |
| ResultsOptions.ShowAnnotations | Boolean | Show annotations/feedback from markers |
| ResultsOptions.Feedback | String(60) | Possible values: ON_ALTERNATIVES ON_QUESTIONS NO_FEEDBACK |
| 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 |
| NavigationType | String(60) | Possible values: CANDIDATE_DELIVERY ORIGINAL_FORM |
| 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 |
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
| Code | Description |
|---|---|
| 200 | Successful operation |
| 403 | Not allowed to use external API |
| 400 | Possible error codes: 1101: Review session has not been found. |
| 500 | Internal server error |