Firechecks

Withdraw a Whole Fire Check Batch

Changed on

Requires permission: StaffMember

Withdraws every record created by one submission, in one action. The remedy for a mis-entered multi-house round, which can be up to eighteen records. Atomic; already-withdrawn records are left as they are.

post/FireChecks/Batches/{batchId}/Withdraw

Request

  • Base URL: https://api.tonbridge.school
  • URL: https://api.tonbridge.school/FireChecks/Batches/{batchId}/Withdraw
  • Auth: HTTP bearer

Path parameters

batchIdstring guid required

Query parameters

pageinteger required
pageSizeinteger required
includesstring[] nullable
sortstring nullable
filterstring nullable

Response

Success - Batch withdrawn

withdrawnCountinteger

Changes