Skip to main content
GET
Exams By Week

Authorizations

token
string
header
required

Path Parameters

installSid
string
required

Install Sid

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

Query Parameters

offset
integer

Result offset

Required range: x >= 0
limit
integer

Number of items to return

Required range: x >= 0
courseOfferingSid
string

Course offering sid

Pattern: ^CO[a-f0-9]{32}$
groupBy
enum<string>
default:examOpenDate

The base for grouping the exams

Available options:
examOpenDate,
examCloseDate
status
enum<string>

Active status of the exams

Available options:
past,
active,
upcoming
startDate
string

earliest date to show exams

endDate
string

Latest date to show exams

Response

200 - application/json

Successful

total
number | null
first
string | null
next
string | null
prev
string | null
last
string | null
count
number | null
offset
number | null
startDate
string | null
endDate
string | null
lastEvaluatedKey
string | null
results
object[]