SMsmarterproctoring
Exam Session

Cancel Exam Session

Cancels the specified exam session. The auth token is passed for auditing.<br/><br/>An optional payload may include cancellation reason details.

delete/v1/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}

Request

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

Path parameters

installSidstring required

Install Sid

examSidstring required

Exam Sid

sessionSidstring required

Exam Session Sid

Request body

type'b-virtual' | 'ad-hoc' | 'instructor-as-proctor' | 'messaging' | 'proctoru' | 'register-blast' | 'vtc' | 'examity' | 'smarter-scheduling' | 'automated'
cancellationMemostring required

Memo for cancelling the exam session

reason'no-show' | 'changed-time' | 'technical-issue' | 'other-reason' | 'removed-by-limited-scope'

Reason for session cancellation

bypassNonRefundableboolean

Whether to bypass non-refundable scheduling fees. If true, all non-refundable fees will be refunded

Response

Successful

string required

Changes

No recorded changes to this operation across all 13 revisions of this API.