v2

latestOpenAPI 3.0.02026-07-2163203194.5 KB

Exam Configuration

Create Configuration

Creates a new exam configuration (e.g., student-specific overrides for scheduling windows, permitted items, and proctoring settings).<br/><br/>The payload must include either enrollmentSid or referenceExamConfigurationSid (XOR constraint).

post/v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}/configurations

Path parameters

installSidstring required

Application install sid

courseSidstring required

Course Sid

examSidstring required

Exam Sid

Request body

examOpenDatestring required

Exam Open Date

examCloseDatestring required

Exam Close Date

scheduleOpenDatestring nullable

Schedule Open Date

scheduleCloseDatestring nullable

Schedule Close Date

enrollmentSidstring

Enrollment sid

urlstring nullable

Exam Url

passwordstring

Password

durationinteger required

Duration Minutes

attemptsinteger required

Attempts Allowed

requiredSoftwarestring nullable required

Required Software

studentNotesstring nullable required

Student Notes

virtualCalculatorTypestring nullable

Virtual Calculator Type

permittedBathroomBreakboolean required

Is Bathroom Break permitted

permittedBathroomBreakInformationstring nullable required

Additional Information about bathroom break

permittedBlankPaperboolean required

Is blank paper permitted

permittedBlankPaperInformationstring nullable required

Additional Information about blank paper

permittedCalculatorboolean required

Is calculator permitted

permittedCalculatorInformationstring nullable required

Additional Information about calculator

permittedDictionaryboolean required

Is Dictionary permitted

permittedDictionaryInformationstring nullable required

Additional Information about Dictionary

permittedEarplugsboolean required

Is Earplugs permitted

permittedEarplugsInformationstring nullable required

Additional Information about Earplugs

permittedFormulaSheetboolean required

Is FormulaSheet permitted

permittedFormulaSheetInformationstring nullable required

Additional Information about FormulaSheet

permittedNotesboolean required

Is Notes permitted

permittedNotesInformationstring nullable required

Additional Information about Notes

permittedOtherItemsstring nullable required

Other permitted Items

permittedTextbookboolean required

Is Textbook permitted

permittedTextbookInformationstring nullable required

Additional Information about Textbook

permittedWebsitesboolean required

Is Websites permitted

permittedWebsitesInformationstring nullable required

Additional Information about Websites

proctorNotesstring nullable required

Proctor Notes

proctorTypesstring[]

Types of proctor for exam

referenceExamConfigurationSidstring nullable

referenceExamConfigurationSid

modalityOptionsModalityOptions

List of modality options

Example request

{
  "instructorAsProctor": [
    {
      "startTime": "1970-01-01T00:00:00.000Z"
    }
  ],
  "examOpenDate": "1970-01-01T00:00:00.000Z",
  "examCloseDate": "1970-01-01T00:00:00.000Z",
  "scheduleOpenDate": "1970-01-01T00:00:00.000Z",
  "scheduleCloseDate": "1970-01-01T00:00:00.000Z"
}

Response

Successful

sidstring nullable

Configuration SID

examSidstring nullable

Exam SID

enrollmentSidstring nullable

Enrollment SID

referenceExamConfigurationSidstring nullable

Reference exam configuration SID

typestring nullable

Configuration type

examOpenDatestring nullable

Exam open date

examCloseDatestring nullable

Exam close date

scheduleOpenDatestring nullable

Schedule open date

scheduleCloseDatestring nullable

Schedule close date

passwordstring nullable

Exam password

urlstring nullable

Exam URL

durationnumber nullable

Duration in minutes

attemptsnumber nullable

Number of attempts

attemptsRemainingnumber nullable

Attempts remaining

lockedboolean nullable

Whether locked

approvedboolean nullable

Whether approved

approvedBystring nullable

Approved by

requiredSoftwarestring nullable

Required software

studentNotesstring nullable

Student notes

permittedBathroomBreakboolean nullable

Bathroom break permitted

permittedBathroomBreakInformationstring nullable

Bathroom break info

permittedBlankPaperboolean nullable

Blank paper permitted

permittedBlankPaperInformationstring nullable

Blank paper info

permittedCalculatorboolean nullable

Calculator permitted

permittedCalculatorInformationstring nullable

Calculator info

permittedDictionaryboolean nullable

Dictionary permitted

permittedDictionaryInformationstring nullable

Dictionary info

permittedEarplugsboolean nullable

Earplugs permitted

permittedEarplugsInformationstring nullable

Earplugs info

permittedFormulaSheetboolean nullable

Formula sheet permitted

permittedFormulaSheetInformationstring nullable

Formula sheet info

permittedNotesboolean nullable

Notes permitted

permittedNotesInformationstring nullable

Notes info

permittedOtherItemsstring nullable

Other permitted items

permittedTextbookboolean nullable

Textbook permitted

permittedTextbookInformationstring nullable

Textbook info

permittedWebsitesboolean nullable

Websites permitted

permittedWebsitesInformationstring nullable

Websites info

apiExamIdstring nullable

API exam ID

examSyncStatusstring nullable

Exam sync status

virtualCalculatorTypestring nullable

Virtual calculator type

synchronizationstring nullable

Synchronization info

proctorNotesstring nullable

Proctor notes

proctorTypesstring[] nullable

Proctor types

attachmentsstring nullable

Attachments

examFilesstring nullable

Exam files

instructorAsProctorstring[] nullable

Instructor as proctor

examstring nullable

Associated exam

coursestring nullable

Associated course

enrollmentstring nullable

Associated enrollment

createdDatestring nullable

Created date

editDatestring nullable

Last modified date

instructorstring nullable

Instructor details

modalityOptionsstring nullable

Modality options

updatedAutomatedSessionsstring nullable

Updated automated sessions