Sign in

v2

OpenAPI 3.0.02026-07-2163203194.5 KB
Exam

Create Exam

Creates a new exam configuration under the specified course.<br/><br/>The payload includes exam metadata (title, type, URL), proctoring configuration, permitted items, scheduling windows, and instructor-as-proctor settings.

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

Path parameters

installSidstring required

Unique SID of the application install. Pattern: AI + 32 hex chars.

Example:AI1234567890abcdef1234567890abcdef

Unique SID of the application install. Pattern: AI + 32 hex chars.

courseSidstring required

Unique SID of the course. Pattern: CU + 32 hex chars.

Example:CU1234567890abcdef1234567890abcdef

Unique SID of the course. Pattern: CU + 32 hex chars.

Request body

titlestring required

Display title for the exam.

type'Online' | 'Written' required

Exam type. Online for web-based exams (requires URL and password), Written for paper-based exams.

descriptionstring nullable

Optional description providing additional details about the exam.

useProctorManagerboolean required

Whether to use the proctor manager for automated proctor assignment.

requireApprovalboolean required

Whether exam sessions require manual approval before the student can begin.

urlstring required

Exam URL

enableAppointmentSuggestionsboolean required

Whether to show suggested appointment time slots to students during scheduling.

examDeliverySystemModulestring nullable

Identifier for the exam delivery system module (e.g., LMS integration module name). Optional field controlled by feature flag.

contactUserSidstring nullable

SID of the user to contact for exam-related issues. Pattern: US + 32 hex chars.

isLimitedScopeboolean

When true, the exam is assigned to specific students only. When false, all enrolled students can take the exam.

status'active' | 'draft' | 'deleted'

Status of the exam. active exams are visible to students, draft are in preparation, deleted are soft-deleted.

Example request

{
  "title": "Midterm Exam 1",
  "type": "Online",
  "description": "Covers chapters 1-5",
  "useProctorManager": true,
  "enableAppointmentSuggestions": true,
  "examDeliverySystemModule": "canvas",
  "contactUserSid": "US1234567890abcdef1234567890abcdef",
  "configuration": {
    "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",
    "virtualCalculatorType": "scientific-calc"
  },
  "status": "active"
}

Response

Successful

sessionStatusstring nullable

Session status

sidstring nullable

Exam SID

courseSidstring nullable

Course SID

applicationInstallSidstring nullable

Application install SID

titlestring nullable

Exam title

bVirtualTitlestring nullable

Virtual title

typestring nullable

Exam type

descriptionstring nullable

Description

useProctorManagerboolean nullable

Use proctor manager

requireApprovalboolean nullable

Require approval

enableAppointmentSuggestionsboolean nullable

Enable appointment suggestions

urlstring nullable

Exam URL

statusstring nullable

Exam status

createdDatestring nullable

Created date

editDatestring nullable

Last modified date

contactUserSidstring nullable

Contact user SID

examDeliverySystemModulestring nullable

Exam delivery system module

summarystring nullable

Exam summary

pendingApprovalsnumber nullable

Pending approvals count

openSessionEventsnumber nullable

Open session events count

coursestring nullable

Course details

configurationstring nullable

Exam configuration

examSessionstring nullable

Exam session

instructorNamestring nullable

Instructor name

courseNamestring nullable

Course name

totalSessionsnumber nullable

Total sessions

needsProctorSessionsnumber nullable

Sessions needing proctor

scriptNamestring nullable

Script name

systemNamestring nullable

System name

isLimitedScopeboolean nullable

Is limited scope

platformVersionstring nullable

Platform version