List Exams - SmarterServices Platform

Authorizations

token

string

header

required

Path Parameters

installSid

string

required

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

Pattern: ^AI[a-f0-9]{32}$

Example:

"AI1234567890abcdef1234567890abcdef"

courseSid

string

required

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

Pattern: ^CU[a-f0-9]{32}$

Example:

"CU1234567890abcdef1234567890abcdef"

Query Parameters

offset

integer

Zero-based offset for pagination.

Required range: x >= 0

Example:

0

limit

integer

Maximum number of exam records to return.

Required range: x >= 0

Example:

50

includeStatusSummary

boolean

default:false

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

Example:

true

sortKeys

enum<string>[]

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

Available options:

title,

examOpenDate,

scheduleOpenDate

sortOrder

enum<string>

Sort direction. ASC for ascending or DESC for descending.

Available options:

ASC,

DESC

dob

string<date>

Date of birth filter (internal use).

Response

default - application/json

Successful

The response is of type string.