SMsmarterproctoring
Reports

List Appointments

Changed on

Returns all appointments based on the given filter parameters.

get/v1/installs/{installSid}/reports/appointments

Request

  • Base URL
    https://api.smarterproctoring.com
  • URL
    https://api.smarterproctoring.com/v1/installs/{installSid}/reports/appointments
  • Auth
    API key in header token

Path parameters

installSidstring required

Install Sid

Query parameters

offsetinteger

Result offset

limitinteger

Number of items to return

courseSidstring

Course sid

examSidstring

Exam sid

courseOfferingSidstring

Course offering sid

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

Type of the appointment

status'Needs Proctor' | 'Scheduled' | 'Cancelled' | 'In Progress' | 'Closed'

Status of the appointment

reviewStatus'pending' | 'complete' | 'not-required'

If the session needs to be reviewed and/or if it has been reviewed.

examStatus'active' | 'draft' | 'deleted'

Status of the exam

appointmentAfterstring

Appointments after date

Example:1970-01-01T00:00:00.000Z
appointmentBeforestring

Appointments before date

Example:1970-01-01T00:00:00.000Z
learnerFirstNamestring

learner first name

learnerLastNamestring

Learners last name

learnerEmailstring

Learners email

learnerSidstring

Learners sid

courseTitlestring

Course title

examTitlestring

Exam title

onlyActiveboolean

When true (default) only active exam sessions are returned. When false, sessions are returned regardless of their active state.

Response

Successful

totalnumber nullable
firststring nullable
nextstring nullable
prevstring nullable
laststring nullable
countnumber nullable
offsetnumber nullable

Changes