Skip to main content

Importing from your MIS

To import users (staff/student) and classes its best to get that data straight from your MIS.

It's hard to define this exactly as every school uses different conventions for usernames and display names, as well as MIS.

The basic principal is that you send a POST request to /import/staff, /import/students and /import/classes. This request needs to have the header Import-Token set to the value in your configuration.

For staff:

  • Name
  • Username

For Students:

  • Name
  • Username
  • UPN (Unique Pupil Number)
  • Year Group
  • Registration Group

For Classes:

  • Name
  • Teacher's Username
  • Array of Student UPNs

An example script is supplied which runs SIMS Reports, parses the data and builds the objects for Start Screen and then sends them to the import addresses.