Skip to main content
GET
List enrollment exam sessions

Authorizations

token
string
header
required

Path Parameters

installSid
string
required

Install Sid

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

Enrollment Sid

Pattern: ^EN[a-f0-9]{32}$
examSid
string
required

Exam Sid

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

Query Parameters

offset
integer

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

Required range: x >= 0
limit
integer

Number of items to return

Required range: x >= 0
sortKeys
enum<string>[]

Sort keys

Available options:
createdDate
sortOrder
enum<string>
default:ASC

Sort order

Available options:
ASC,
DESC
status
enum<string>[]

Status List

Available options:
Needs Proctor,
Pending Approval,
Approval Denied,
Scheduled,
Incident,
Closed,
Processing
includeActive
boolean
default:false

Include Active Session

Response

200 - application/json

Successful

total
number

Total number of results

first
string | null

URL for first page

next
string | null

URL for next page

prev
string | null

URL for previous page

last
string | null

URL for last page

count
number

Number of results in this page

offset
number

Current offset

results
object[]

Exam session records