Sanctions

Get sanctions (grid)

Changed on

Requires permission: SanctionsAccess

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

get/sanctions

Request

  • Base URL: https://api.tonbridge.school
  • URL: https://api.tonbridge.school/sanctions
  • Auth: HTTP bearer

Query parameters

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

Response

Success - sanctions returned

totalRowsinteger nullable

Changes

  • 36dba1c77613Revision changes
    • breaking

      the /////// response's property format changed from int32 to int64 for status

    • breaking

      the /////// response's property format changed from int32 to int64 for status

    • breaking

      the /////// response's property format changed from int32 to int64 for status

    • breaking

      the /////// response's property format changed from int32 to int64 for status

    • info

      for the query request parameter subjectIds, the format of property items/ was generalized from int32 to int64

    • info

      for the query request parameter staffNameId, the format was generalized from int32 to int64

    • info

      for the query request parameter studentNameId, the format was generalized from int32 to int64