Sign in
Reports

Apply chosen changes since setup to a live report

Changed on

Requires permission: ReportAdmins

Recomputes the report's differences from the MIS and applies the ones named by id, all or nothing: joiners get entries, leavers' blank entries are removed (written ones only with RemoveWritten), and teacher changes hand the entries over. Ids that are no longer a difference, or cannot be applied, are skipped and counted.

post/reports/{reportId}/changes/apply

Request

  • Base URL: https://api.tonbridge.school
  • URL: https://api.tonbridge.school/reports/{reportId}/changes/apply
  • Auth: HTTP bearer

Path parameters

reportIdinteger required

Request body

idsstring[] nullable
removeWrittenboolean nullable

Response

Success - Applied

entriesAddedinteger
entriesRemovedinteger
entriesHandedOverinteger
skippedinteger

Changes