SMsmarterproctoring
Exam

Update Exam

Changed on

Replaces the full exam configuration with the provided payload.<br/><br/>Includes exam metadata, scheduling windows, permitted items, proctoring settings, and instructor-as-proctor configurations.<br/><br/>The user role from the auth token is passed to the handler for role-based logic.

put/v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}

Request

  • Base URL
    https://api.smarterproctoring.com
  • URL
    https://api.smarterproctoring.com/v1/installs/{installSid}/courses/{courseSid}/exams/{examSid}
  • Auth
    API key in header token

Path parameters

installSidstring required

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

Example:AI1234567890abcdef1234567890abcdef
courseSidstring required

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

Example:CU1234567890abcdef1234567890abcdef
examSidstring required

Unique SID of the exam to update. Pattern: EX + 32 hex chars.

Example:EX1234567890abcdef1234567890abcdef

Request body

titlestring required

Title C

type'Online' | 'Written' required

Type C

descriptionstring nullable

Description C

useProctorManagerboolean required

Use Proctor Manager C

requireApprovalboolean required

Require Approval C

examDeliverySystemModulestring nullable

Exam Delivery System Module. Optional field controlled by feature flag.

contactUserSidstring nullable

Contact User Sid

isLimitedScopeboolean

Boolean to assign exam to all or a few students

urlstring required

Exam URL

enableAppointmentSuggestionsboolean required

Enable Appointment Suggestions C

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

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

Example request

{
  "configuration": {
    "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",
    "instructorAsProctor": [
      {
        "startTime": "1970-01-01T00:00:00.000Z"
      }
    ],
    "allowedSites": [
      {
        "label": "Cengage SALT",
        "url": "https://www.webassign.net/csalt/",
        "match": "prefix"
      }
    ],
    "allowedSitesInheritance": "inherit"
  },
  "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

Changes

  • 3c01f1377241Revision changes
    • info

      added the new allowAll enum value to the request property /

  • 3b855ae7aacdRevision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property /