Sign in
Admin

Preview a historical enrolment import

Changed on

Requires permission: IT

Reads an Excel extract from the School's previous MIS, matches each row to a pupil on ExternalId or ExternalId2, and reports what would happen. Writes nothing. Rows for the current academic year are counted and skipped: the current year belongs to the nightly sync.

post/Admin/Mis/Import/Enrolments/Preview

Request

  • Base URL: https://api.tonbridge.school
  • URL: https://api.tonbridge.school/Admin/Mis/Import/Enrolments/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