v2

OpenAPI 3.0.02026-07-2163203194.5 KB
Exam Session

List enrollment exam sessions

Returns a paginated list of exam sessions for the given enrollment and exam combination.

get/v1/installs/{installSid}/enrollments/{enrollmentSid}/exams/{examSid}/sessions

Path parameters

installSidstring required

Install Sid

Install Sid

enrollmentSidstring required

Enrollment Sid

Enrollment Sid

examSidstring required

Exam Sid

Exam Sid

Query parameters

offsetinteger

Id to get next portion of query data. For 1st query should pass as empty

Id to get next portion of query data. For 1st query should pass as empty

limitinteger

Number of items to return

Number of items to return

sortKeysstring[]

Sort keys

Sort keys

sortOrder'ASC' | 'DESC'

Sort order

Sort order

statusstring[]

Status List

Status List

includeActiveboolean

Include Active Session

Include Active Session

Response

Successful

totalnumber

Total number of results

firststring nullable

URL for first page

nextstring nullable

URL for next page

prevstring nullable

URL for previous page

laststring nullable

URL for last page

countnumber

Number of results in this page

offsetnumber

Current offset