v2

OpenAPI 3.0.02026-07-2163203194.5 KB
Reports

Exam Overview

Returns an exam overview report for the specified install.

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

Path parameters

installSidstring required

Install Sid

Install Sid

Query parameters

courseOfferingSidstring

Course offering

Course offering

courseTitlestring

Title of the course

Title of the course

courseCodestring

Course code

Course code

examTitlestring

Title of the exam

Title of the exam

instructorFirstNamestring

First name of the instructor

First name of the instructor

instructorLastNamestring

Last name of the instructor

Last name of the instructor

examOpenDatestring

Exam Open date, must provide close date with it

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

Exam Open date, must provide close date with it

examCloseDatestring

Exam Close date, must provide open date with it

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

Exam Close date, must provide open date with it

examScheduleOpenDatestring

Exam Session Open date, must provide close date with it

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

Exam Session Open date, must provide close date with it

examScheduleCloseDatestring

Exam Session Close date, must provide open date with it

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

Exam Session Close date, must provide open date with it

needsProctorboolean

Show only the exam that needs proctor

Show only the exam that needs proctor

offsetinteger

Result offset

Result offset

limitinteger

Number of items to return

Number of items to return

sortBy'status needs proctor' | 'status cancelled' | 'status scheduled' | 'status closed' | 'examOpenDate' | 'examCloseDate' | 'examScheduleOpenDate' | 'examScheduleCloseDate' | 'examTitle' required

Key to sort by

Key to sort by

Response

Successful

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