v2

OpenAPI 3.0.02026-07-2163203194.5 KB
Exam Session Annotation

List Annotations

Returns a paginated list of annotations for the specified exam session.<br/><br/>Supports filtering and sorting via query parameters.

get/v2/installs/{installSid}/exams/{examSid}/sessions/{sessionSid}/annotations

Path parameters

installSidstring required

Install Sid

Install Sid

examSidstring required

Exam Sid

Exam Sid

sessionSidstring required

Exam Session Sid

Exam Session Sid

Query parameters

typeIdstring

Type identifier for the annotation

Type identifier for the annotation

categoryIdstring

Category for the annotation type

Category for the annotation type

reviewedboolean

Filter annotations by reviewed status

Filter annotations by reviewed status

afterstring

Filter annotations created after this date

Filter annotations created after this date

beforestring

Filter annotations created before this date

Filter annotations created before this date

sortKeysstring[]

Sorting keys

Sorting keys

sortOrder'ASC' | 'DESC'

Sorting order

Sorting order

offsetinteger

Pagination offset

Pagination offset

limitinteger

Pagination limit

Pagination limit

Response

Successful

string required