Get Assessment info
- 19 Jan 2024
- 3 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Get Assessment info
- Updated on 19 Jan 2024
- 3 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Get Assessment info
Get /assessment/{externalId}
Header
| Name | Data Type | Description |
|---|---|---|
| Content-type: | application/json | for all requests |
| Authorization: | EAPI {token} | for all requests |
Request Parameters
Parameters indicated with a * are mandatory
| Parameter | Type | Description |
|---|---|---|
| externalId | String(64) | Assessent external id |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| Title | String | Assessment title |
| ExternalId | String | Assessent external id |
| Revision | integer | Version of the assessment |
| Purpose | integer | Assessment purpose Possible values: 1 - Summative 2 - Formative 3 - Mixed |
| Code | String | Assessment code |
| Status | String | Assessment workflow status Possible values: 1 -Draft 2 - Live |
| IsPublished | Boolean | True if assessment is published |
| Availability | Integer | Type of assessment availability Possible values: 0 - Always (assessment is always available for scheduling) 1 - TimeSpan(assessment is available for scheduling only during predefined time span) |
| AvailabilityStartDate | DateTime | Date and time after which assessment becomes available for scheduling (It can be null even if TimeSpan type is used) |
| AvailabilityEndDate | DateTime | Date and time after which assessment becomes unavailable for scheduling (It can be null even if TimeSpan type is used) |
| Type | Integer | Assessment type Possible values: 1 - Manual 2 - Blueprint |
| AssignmentConnections | Array[Objects] | Array of assignment connections(Clusters or Hierarchies) |
| AssignmentConnections[].Title | string | Title of connection |
| AssignmentConnections[].Type | String | Type of connection (“cluster” or “hierarchy”) |
| AllowedNumberOfAttempts | Integer | Allowed number of attempts (null if unlimited) |
| WhichAttemptCounts | Integer | Which attempt counts Possible values: 0 - Last 1 - Best |
| ReasonableAdjustmentType | String | Type extra time/reasonable adjustments Possible values: NOT_DEFINED PERCENTAGE CUSTOM UNLIMITED |
| MaxTimePerAttempt | Integer | Max time per attempt (in minutes, null if unlimited) |
| ExtraTime | Integer | Extra time for candidates with special needs (in minutes, null if unlimited) |
| ShowResults | Integer | Show results Possible values: null - Not defined 0 - Never 1 - After each attempt 2 - After all attempts 3 - When assessor decides |
| ShowSummary | Boolean | True: show which questions the candidate answered correctly in candidate results |
| ShowDetailedResult | Boolean | True: show the correct answer to each question in candidate results |
| ShowScoreReportwithSubjects | Boolean | True: show the subject achievement (score report) in candidate results |
| ScoreReportWithObjectives | Boolean | True: show the learning objective achievement (score report) in candidate results |
| ScoreReportWithTopics | Boolean | True: show the Topics achievement (score report) in candidate results |
| FeedbackType | Integer | Feedback type Possible values: 1 - On alternatives 2 - On questions 3 - No feedback |
| ShowFeedbackAfterEachQuestion | Boolean | True: show feedback after each question |
| ShowFeedbackOnResultsPage | Boolean | True: show feedback on ResultPage |
| QuestionsRandomOrder | Boolean | True: display questions in random order (present the questions in a random order from candidate to candidate) |
| QuestionNavigation | Integer | Question navigation Possible values: 1 - Forward only 2 - Free navigation |
| UsePIN | Boolean | True: PIN check is enabled |
| LockDownBrowser | Boolean | True: safe exam browser is enabled (for high stake assessment, lock-down mode is recommended. Hereby candidates cannot leave the assessment while in progress) |
| MarkingWorkflow | Integer | Marking workflow type Possible values: 0 - Undefined 1 - No marking 2 - Simple 3 - Extended |
| Calculator | Boolean | True: web-based calculator for candidates is enabled |
| UseProctorIo | Boolean | True: remote proctoring is turned on |
| UseKeycode | Boolean | True: Keycode is turned on |
| Workout | String | Workout box Possible values: NO_WORKOUT_BOX ONLY_SELECTED_QUESTIONS ALL_QUESTIONS |
| AddedUsers | Array of objects | Array of assessment members |
| AddedUsers[].UserName | String | UserName |
| AddedUsers[].Role | String | User’s role (Name of role from Assessment Roles) |
| AddedUsers[].IsOwner | AddedUsers[].IsOwner | True: user is owner(creator) |
| Deleted | String | True: Assessment in quarantine |
| Forms | Array of objects | Assessment forms info |
| Forms[].Title | String | Title of assessment form |
| Forms[].PassPercent | Decimal | Percent to pass form |
| Forms[].Sections | Array of objects | Array of sections |
| Forms[].Sections[].Id | String | Section external Id |
| Forms[].Sections[].MaxScore | Integer | Max score for section |
| Forms[].Sections[].PassMark | Decimal | Pass mark |
| Forms[].Sections[].PassType | String | Pass Type: Percent or Scoring |
| showGrade | Boolean | True: show Grades in candidate results |
| showPercentageToPass | Boolean | True: show passing percentage |
| showResultOutcome | Boolean | True: show result outcome (passed/failed) in candidate results |
Sample Request URL
https://api.cirrusplatform.com/api/v1/integrations/assessment/Ext_a_2
Sample successfull Response
{
"Content": {
"Title": "External assessment",
"ExternalId": "Ext_a_2",
"Purpose": 3,
"Code": "ext_assessment_2",
"Status": 1,
"IsPublished": false,
"Availability": 1,
"AvailabilityStartDate": "2018-06-06T17:34:04.991Z",
"AvailabilityEndDate": null,
"Type": 1,
"AssignmentConnections": [{"Title": "group_1", "Type": "hierarchy"}, {"Title": "cluster_1", "Type": "cluster"}],
"AllowedNumberOfAttempts": 10,
"WhichAttemptCounts": 1,
"MaxTimePerAttempt": null,
"ReasonableAdjustmentType": "CUSTOM",
"ExtraTime": 0,
"ShowResults": 2,
"ShowOnlyStatus": false,
"ShowSummary": true,
"ShowDetailedResult": true,
"ShowScoreReport": false,
"ReportWithObjectives": false,
"FeedbackType": 3,
"QuestionsRandomOrder": false,
"QuestionNavigation": 2,
"UsePIN": false,
"LockDownBrowser": false,
"MarkingWorkflow": 1,
"Calculator": true,
"AddedUsers": [{
"UserName": "mariag",
"Role": "Author",
"IsOwner": true
}, {
"UserName": "belkin",
"Role": "Author",
"IsOwner": false
}
],
"Deleted": false
},
"Success": true,
"Errors": null
}
Response codes
| Code | Description |
|---|---|
| 200 | Successful operation |
| 403 | Not allowed to use external API |
| 400 | Possible error codes: Assessment hasn't been found by external id externalId |
| 500 | Internal server error |
Was this article helpful?