Reports

Exams By Week

Returns exams grouped by week based on the given filter parameters.

get/v1/installs/{installSid}/examsByWeek

Request

  • Base URL
    https://api.smarterproctoring.com
  • URL
    https://api.smarterproctoring.com/v1/installs/{installSid}/examsByWeek
  • Auth
    API key in header token

Path parameters

installSidstring required

Install Sid

Query parameters

offsetinteger

Result offset

limitinteger

Number of items to return

courseOfferingSidstring

Course offering sid

groupBy'examOpenDate' | 'examCloseDate'

The base for grouping the exams

status'past' | 'active' | 'upcoming'

Active status of the exams

startDatestring

earliest date to show exams

endDatestring

Latest date to show exams

Response

Successful

totalnumber nullable
firststring nullable
nextstring nullable
prevstring nullable
laststring nullable
countnumber nullable
offsetnumber nullable
startDatestring nullable
endDatestring nullable
lastEvaluatedKeystring nullable
resultsModel4[]

Changes

No recorded changes to this operation across all 13 revisions of this API.