v7

latestOpenAPI 3.0.02026-08-046241,3352.0 MB
Sanctions

Get sanctions (grid)

Requires permission: SanctionsAccess

The filterable/sortable sanctions grid, scoped to the houses and subjects the caller has access to.

get/sanctions

Query parameters

permissionNamestring nullable
staffNameIdinteger nullable
studentNameIdinteger nullable
studentYearinteger nullable
searchQuerystring nullable
houseCodesstring[] nullable
subjectIdsinteger[] nullable
sanctionTypeIdinteger nullable
attendance0 | 1 | 2
category0 | 1 | 2
boardingSanctionTypeboolean nullable
daySanctionTypeboolean nullable
fromDatestring date-time nullable
toDatestring date-time nullable
pageSizeinteger nullable
pageNumberinteger nullable

Response

Success - sanctions returned

totalRowsinteger nullable