Sign in
Admin

Preview a historical class membership import

Changed on

Requires permission: IT

Reads an Excel extract of historical classes and who was in them, resolves the classes first and then hangs membership off them, and reports what would happen. Writes nothing. Classes the app has never seen are reported as would-be-created, and are created archived (InUse = false) so they never appear in a current-year picker.

post/Admin/Mis/Import/ClassMembership/Preview

Request

  • Base URL: https://api.tonbridge.school
  • URL: https://api.tonbridge.school/Admin/Mis/Import/ClassMembership/Preview
  • Auth: HTTP bearer

Query parameters

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

Response

Success - what the import would do

kindstring
fileNamestring nullable
sheetNamestring nullable
rowsReadinteger
matchedinteger
unmatchedinteger
wouldInsertinteger
wouldUpdateinteger
currentYearRowsIgnoredinteger
yearsAffectedstring[]
warningsstring[]
batchIdstring guid nullable
rowsWritteninteger nullable

Changes