API to control test settings

V 1.0

This document covers documentation of v1/test/{testID}/options API and functions allowed to perform on test settings.

General information

Release date: 02 Oct 2020

Technical documentation: https://ia.inspera.no/apidoc/#/test/setTestOptions

API will allow for set/update/remove of test settings through integration endpoints. The settings are following standard setting groupings of Inspera Assessment “Deliver” module settings and options:

General settings
Security
Exam day
After test
Grading workflow
Explanation of grades

For more in-depth documentation regarding feature releases, please see section “Recent changes” in this document.

Future releases (estimated, not confirmed)

Recent changes

V 1.0

Release: 02 Oct 2020

Security options

API section model:

"securityOptions": 
        [
            "SEB_SETTINGS_PINCODE": "string",
            "LOCKDOWN_BROWSER" : boolean (default false),
            "LOCKDOWN_QUIT_CODE" : "string",
            "LOCKDOWN_CHROME_KIOSK": boolean (default false)
         ]

Important conditions:

"LOCKDOWN_QUIT_CODE" (invigilator password) is shared for Chromebook and SEB lockdown. If value is sent as update for one option, it will automatically be valid for both SEB and Chromebook settings
"SEB_SETTINGS_PINCODE" must be minimum 6 characters long and consist of both letters and numbers. Other language characters than English are not supported, only printable ASCII characters!
Security settings can only be changed until test is activated

API section body example:

{
    "testOptions": 
    {
        "securityOptions": 
        [
            {
                "option": "SEB_SETTINGS_PINCODE",
                "value": "seb123"
            },
            {
                "option": "LOCKDOWN_BROWSER",
                "value": true
            },
            {
                "option": "LOCKDOWN_QUIT_CODE",
                "value": "exitlockdown"
            },
            {
                "option": "LOCKDOWN_CHROME_KIOSK",
                "value": true
            }
        ]
    }
}

Explanation options

API section model

"explanationOptions": 
        [
                "EXPLANATION_OF_GRADES_ADMINISTRATION_ENABLED" : boolean (default false)
                "EXPLANATION_OF_GRADES_REQUESTED_FOR_ALL_GRADES" : boolean (default false)
                "EXPLANATION_OF_GRADES_DIRECTLY_TO_CANDIDATES_ENABLED" : boolean (default false)
                "EXPLANATION_OF_GRADES_DEADLINE_ENABLED" : boolean (default false)
                "EXPLANATION_DEADLINE" : string(date-time)
        ]

Important conditions:

"EXPLANATION_OF_GRADES_ADMINISTRATION_ENABLED" must be set to “true” before other settings in section can be changed
When updating of explanation settings, "EXPLANATION_OF_GRADES_ADMINISTRATION_ENABLED" can be omitted if it is set to “true” in previous call
When disabling all explanation settings, only"EXPLANATION_OF_GRADES_ADMINISTRATION_ENABLED" = false needs to be sent in api call.

API section body example:

{
    "testOptions": 
    {
       "explanationOptions": [
            {
                "option": "EXPLANATION_OF_GRADES_ADMINISTRATION_ENABLED",
                "value": true
            },
            {
                "option": "EXPLANATION_OF_GRADES_REQUESTED_FOR_ALL_GRADES",
                "value": false
            },
            {
                "option": "EXPLANATION_OF_GRADES_DIRECTLY_TO_CANDIDATES_ENABLED",
                "value": false
            },
            {
                "option": "EXPLANATION_OF_GRADES_DEADLINE_ENABLED",
                "value": true
            },
            {
                "option": "EXPLANATION_DEADLINE",
                "value": "2020-10-10"
            }
        ]
    }
}

v 1.1

release 06 Nov 2020

Exam day options

API section model:

"examDayOptions": 
[
    "SPELL_CHECKER_DISABLED" :boolean (default false),
    "ENABLE_SCAYT":boolean (default false),
    "ENABLE_TTS":boolean (default false),
    "DISABLE_SKETCHES_IN_ESSAY_QUESTIONS":boolean (default false),
    "DISABLE_DASHBOARD_ON_EXAM_DAY":boolean (default false), 
    "ENABLE_SKETCHES":boolean (default false), 
    "LOCK_SUBMISSOINS_WHEN_GRADING_STARTS":boolean (default false), 
    "VDI_URL":"string",
    "ENABLE_VDI":boolean (default false)
   ]

Important conditions:

Settings that can be changed after test activation:

"ENABLE_SPELL_CHECKER"
"ENABLE_SCAYT"
"ENABLE_TEXT_TO_SPEECH"
"ENABLE_SKETCHES"
"LOCK_SUBMISSOINS_WHEN_GRADING_STARTS"

Settings that cannot be changed after test activation:

"DISABLE_SKETCHES_IN_ESSAY"
"ENABLE_VDI"

v 1.2

release 03 Dec 2020

General options

API section model:

"generalOption": 
[ 
  ORAL_EXAM:boolean (default false),
  GRADING_ONLY:boolean (default false),
  ENABLE_AUTO_SUBMISSION:boolean (default false), 
  CANDIDATES_CAN_MANUALLY_SUBMIT_MULTIPLE_TIMES:boolean (default false), 
  CANDIDATES_CAN_ONLY_SUBMIT_ONCE:boolean (default false), 
  DO_NOT_ALLOW_CANDIDATE_SUBMISSION:boolean (default false),
  SCANTRON_TEST:boolean (default false), 
  PRELOAD_TEST_BEFORE_START:boolean (default false),
  ACTIVATE_AUTOMATED_TEST_CONSTRUCTION:boolean (default false), 
  DISTRIBUTED_ACCESS:boolean (default false), 
  ANONYMIZE_LOGIN_ON_INVITATION:boolean (default false), 
  THESIS_PUBLICATION:boolean (default false) 
]

API section body example:

{
    "testOptions": 
    {
       "generalOptions": [
            
            {
                "option": "ORAL_EXAM",
                "value": false
            },
            {
                "option": "GRADING_ONLY",
                "value": true
            },{
                "option": "ENABLE_AUTO_SUBMISSION",
                "value": true
            },{
                "option": "CANDIDATES_CAN_MANUALLY_SUBMIT_MULTIPLE_TIMES",
                "value": true
            },{
                "option": "CANDIDATES_CAN_ONLY_SUBMIT_ONCE",
                "value": false
            },{
                "option": "DO_NOT_ALLOW_CANDIDATE_SUBMISSION",
                "value": false
            },{
                "option": "PRELOAD_TEST_BEFORE_START",
                "value": true
            },{
                "option": "ACTIVATE_AUTOMATED_TEST_CONSTRUCTION",
                "value": true
            },{
                "option": "DISTRIBUTED_ACCESS",
                "value": true
            },
            {
                "option": "ANONYMIZE_LOGIN_ON_INVITATION",
                "value": true
            },
            {
                "option": "THESIS_PUBLICATION",
                "value": "Master"
            }
        ]
    }
}

v 1.3

release 07 Jan 2021

After test options

API section model:

"afterTestOptions": 
[ 
    AVAILABILITY_TO(Date),
    ENABLE_POST_FULL_SUBMISSION_REVIEW(Boolean),
    ENABLE_INSTANT_POST_SUBMISSION_REVIEW(Boolean),
    ENABLE_CANDIDATE_OWN_SUBMISSION_DELETION(Boolean),
    HIDE_RESULT_PAGE(Boolean),
    SHOW_TOTAL_MARKS_ONLY(Boolean),
    PUBLISH_FINAL_GRADE(Boolean),
    ENABLE_NOTIFICATION_ON_GRADING_COMPLETE(Boolean),
    SHARE_ANNOTATIONS_WITH_STUDENTS(Boolean),
    COMMENTS_SETTINGS(Boolean),
    PUBLISH_FINAL_GRADE_DATE(Date),
    ENABLE_POST_SUBMISSION_REVIEW(Boolean)
]

API section body example:

{
    "testOptions": 
    {
        "afterTestOptions": 
        [
            {
                "option": "AVAILABILITY_TO",
                "value":"2021-02-03"
            },
            {
                "option": "ENABLE_POST_FULL_SUBMISSION_REVIEW",
                "value": true
            },
            {
                "option": "ENABLE_INSTANT_POST_SUBMISSION_REVIEW",
                "value": true
            },
            {
                "option": "ENABLE_CANDIDATE_OWN_SUBMISSION_DELETION",
                "value": true
            },{
                "option": "HIDE_RESULT_PAGE",
                "value": true
            },{
                "option": "SHOW_TOTAL_MARKS_ONLY",
                "value": true
            },{
                "option": "PUBLISH_FINAL_GRADE",
                "value": true
            },{
                "option": "ENABLE_NOTIFICATION_ON_GRADING_COMPLETE",
                "value": true
            },{
                "option": "SHARE_ANNOTATIONS_WITH_STUDENTS",
                "value": true
            },{
                "option": "COMMENTS_SETTINGS",
                "value": true
            },{
                "option": "PUBLISH_FINAL_GRADE_DATE",
                "value": "2021-02-03"
            },{
                "option": "ENABLE_POST_SUBMISSION_REVIEW",
                "value": true
            }
        ]
    }
}

Return codes

Code	Code information
200	Successful operation
400	No input data or invalid data provided
403	Permission denied
404	Could not resolve test from provided data
409	External Id of test data does not match provided data
500	Internal server error, please contact Inspera support