Students

Import Candidate Numbers

Changed on

Requires permission: IT

Bulk-set exam candidate numbers from an Excel import, matched by MisId (iSAMS SchoolId). Updates both the per-year Students rows and the canonical Pupil rows. Used by the App Admin 'Candidate Numbers' importer because iSAMS does not expose candidate numbers over its REST API. An optional uci per row is written to the Pupil only; a missing or blank uci leaves the stored value alone, unlike candidateNumber, which a null clears.

post/Students/CandidateNumbers/Import

Request

  • Base URL: https://api.tonbridge.school
  • URL: https://api.tonbridge.school/Students/CandidateNumbers/Import
  • Auth: HTTP bearer

Query parameters

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

Request body

Example request

{
  "items": [
    {
      "misId": "12345",
      "candidateNumber": 6001,
      "uci": "616790252080V"
    }
  ]
}

Response

Success - candidate numbers imported

studentsUpdatedinteger
pupilsUpdatedinteger
ucisUpdatedinteger
unmatchedMisIdsstring[]

Changes