Sign in
Students

Import Candidate Numbers

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 API.

post/Students/CandidateNumbers/Import

Query parameters

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

Request body

Example request

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

Response

Success - candidate numbers imported

studentsUpdatedinteger
pupilsUpdatedinteger
unmatchedMisIdsstring[]

Changes

Changed in 1 of the 22 revisions of this API.1