Sign in

v2

latestOpenAPI 3.0.02026-07-2163203194.5 KB
Reports

List Appointments

Returns all appointments based on the given filter parameters.

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

Path parameters

installSidstring required

Install Sid

Install Sid

Query parameters

offsetinteger

Result offset

Result offset

limitinteger

Number of items to return

Number of items to return

courseSidstring

Course sid

Course sid

examSidstring

Exam sid

Exam sid

courseOfferingSidstring

Course offering sid

Course offering sid

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

Type of the appointment

Type of the appointment

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

Status of the appointment

Status of the appointment

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

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

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

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

Status of the exam

Status of the exam

appointmentAfterstring

Appointments after date

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

Appointments after date

appointmentBeforestring

Appointments before date

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

Appointments before date

learnerFirstNamestring

learner first name

learner first name

learnerLastNamestring

Learners last name

Learners last name

learnerEmailstring

Learners email

Learners email

learnerSidstring

Learners sid

Learners sid

courseTitlestring

Course title

Course title

examTitlestring

Exam title

Exam title

Response

Successful

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