SMsmarterproctoring
Exam Session

Exam Session Details

Changed on

Returns the full exam session object including scheduling, proctoring, and status details.

get/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

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

appointmentAuditStatus'approved' | 'reviewed' nullable

Audit status of the appointment (null until audited)

examUrlstring nullable

Exam URL for this session

passwordstring nullable

Exam password for this session (not returned to learners)

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

browserExtensionVersionstring nullable

Browser extension the session was started with

Changes

  • da62d9723eddRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • d63e983a4898Revision changes
    • info

      added the optional property to the response with the status