Sign in

v2

OpenAPI 3.0.02026-07-2163203194.5 KB
Exam Session

Schedule Exam Session

Creates a scheduled exam session under the specified exam.

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

Path parameters

installSidstring required

Install Sid

Install Sid

examSidstring required

Exam Sid

Exam Sid

sessionSidstring required

Exam Session Sid

Exam Session Sid

Request body

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

Session type

notesstring

Notes regarding session

proctorLocationSidstring

The proctor location that is being scheduled for

messageSidstring

The Message Thread that is being scheduled for

currencystring

The 3 digit currency code

amountnumber

The amount the session costs in the currency that was provided

cardTokenstring

The Stripe token

voucherCodestring

If a voucher code is to be used for this transaction

companystring

The company name of the proctor

firstNamestring

The first name of the proctor or testing center contact

lastNamestring

The last name of the proctor or testing center contact

emailstring

The email address of the proctor or testing center contact

phonestring

The phone number of the proctor or testing center contact

address1string

Ad-hoc proctor address line 1

address2string

Ad-hoc proctor address line 2

placestring

Ad-hoc proctor place

regionstring

Ad-hoc proctor region

countrystring

Ad-hoc proctor country

locationLatitudestring

Ad-hoc proctor location latitude

locationLongitudestring

Ad-hoc proctor location longitude

postalCodestring

Ad-hoc proctor postal code

appointmentDateTimestring
instructorProctorSidstring

instructor as proctor sid

externalAppointmentIdstring

External appointmentId for registarblast

cancellationPolicyVersionSidstring

If a cancellationPolicyVersionSid is to be used for this session

examLocalestring nullable

Locale of the exam

proctorTypeSubCategorySidstring

The proctor type that is being scheduled.

Example request

{
  "appointmentDateTime": "1970-01-01T00:00:00.000Z"
}

Response

Successful

sidstring nullable

Session SID

installSidstring nullable

Install SID

examSidstring nullable

Exam SID

enrollmentSidstring nullable

Enrollment SID

userSidstring nullable

User SID

courseSidstring nullable

Course SID

instructorProctorSidstring nullable

Instructor proctor SID

proctorTypeSidstring nullable

Proctor type SID

cancellationPolicySidstring nullable

Cancellation policy SID

cancellationPolicyVersionSidstring nullable

Cancellation policy version SID

statusstring nullable

Session status

statusReasonstring nullable

Status reason

accessKeystring nullable

Access key

durationnumber nullable

Duration

sessionTypestring nullable

Session type

schedulingModulestring nullable

Scheduling module

proctorReviewProcessSidstring nullable

Proctor review process SID

workflowModulestring nullable

Workflow module

appointmentDatestring nullable

Appointment date

appointmentEndDatestring nullable

Appointment end date

dateApprovedstring nullable

Date approved

dateScheduledstring nullable

Date scheduled

createdDatestring nullable

Created date

inProgressDatestring nullable

In progress date

externalAppointmentIdstring nullable

External appointment ID

externalReservedAppointmentIdstring nullable

External reserved appointment ID

externalReservedAppointmentExpiresstring nullable

External reserved appointment expires

externalAppointmentSyncDatestring nullable

External appointment sync date

editDatestring nullable

Last modified date

notesstring nullable

Notes

recordingStartDatestring nullable

Recording start date

accountstring nullable

Account details

installstring nullable

Install details

deploymentstring nullable

Deployment details

sessionReportCountnumber nullable

Session report count

seriesstring nullable

Session series

reviewByDatestring nullable

Review by date

reviewByUserSidstring nullable

Review by user SID

reviewCompletedDatestring nullable

Review completed date

reviewRequiredboolean nullable

Review required

reviewCompleteNotificationUrlstring nullable

Review complete notification URL

reviewedboolean nullable

Reviewed

proctorGroupsstring nullable

Proctor groups

URLstring nullable

Session URL

examLocalestring nullable

Exam locale

platformVersionstring nullable

Platform version

systemCheckStartDatestring nullable

System check start date

systemCheckEndDatestring nullable

System check end date

modalityOptionsstring nullable

Modality options

examstring nullable

Exam details

enrollmentstring nullable

Enrollment details

coursestring nullable

Course details

examFilestring nullable

Exam file

returnedFilestring nullable

Returned file

photosstring nullable

Photos

sessionInfostring nullable

Session info

auditStatusstring nullable

Audit status

examConfigurationstring nullable

Exam configuration

proctorstring nullable

Proctor details

locationstring nullable

Location details

appointmentstring nullable

Appointment details

messagingConfirmationsstring[] nullable

Messaging confirmations

automatedstring nullable

Automated session data

interoadsProvisionedExamUrlstring nullable

Interroads provisioned exam URL

proctorGroupSidstring nullable

Proctor group SID

mandatoryRoomScanVideoboolean nullable

Mandatory room scan video

mutedAnnotationsstring nullable

Muted annotations