v2

OpenAPI 3.0.02026-07-2163203194.5 KB
Exam

List Exams

Returns a paginated list of exams belonging to the specified course.<br/><br/>Supports filtering with includeStatusSummary to include enrollment status counts per exam.<br/><br/>Supports sorting by title, examOpenDate, or scheduleOpenDate.

get/v1/installs/{installSid}/courses/{courseSid}/exams

Path parameters

installSidstring required

Unique SID of the application install. Pattern: AI + 32 hex chars.

Example:AI1234567890abcdef1234567890abcdef

Unique SID of the application install. Pattern: AI + 32 hex chars.

courseSidstring required

Unique SID of the course. Pattern: CU + 32 hex chars.

Example:CU1234567890abcdef1234567890abcdef

Unique SID of the course. Pattern: CU + 32 hex chars.

Query parameters

offsetinteger

Zero-based offset for pagination.

Zero-based offset for pagination.

limitinteger

Maximum number of exam records to return.

Example:50

Maximum number of exam records to return.

includeStatusSummaryboolean

When true, includes a summary of enrollment statuses (e.g., scheduled, completed, not started) for each exam.

Example:true

When true, includes a summary of enrollment statuses (e.g., scheduled, completed, not started) for each exam.

sortKeysstring[]

Array of field names to sort by. Valid values: title, examOpenDate, scheduleOpenDate.

Array of field names to sort by. Valid values: title, examOpenDate, scheduleOpenDate.

sortOrder'ASC' | 'DESC'

Sort direction. ASC for ascending or DESC for descending.

Sort direction. ASC for ascending or DESC for descending.

dobstring date

Date of birth filter (internal use).

Date of birth filter (internal use).

Response

Successful

string required