Overview

This route is used internally by the registration portal to create students. If you have your own custom registration system, you might find integrating with this endpoint helpful.

Endpoint Body

The endpoint takes a request body in the following shape. All fields are required.

{
  email: String,
  gender: String,
  birthdate: Date,

  name: {
    first: String,
    middle: String,
    last: String,
    preferredFirst: String,
    preferredLast: String,
    previous: String,
    pronouns: String
  },

  home: {
    city: String,
    country: String,
    province: String,
    postal: String,
    address: String
  },

  education: {
    school: String,
    grade: String,
    iep: Boolean,
    pen: String
  },

  ancestry: {
    hasStatus: Boolean,
    type: String,
    band: String
  },

  contacts: [{
    name: String,
    phone: String,
    email: String,
  }],

  phones: [String]

}

Field Details

Detailed information about specific fields are below.

gender

Valid values are “male”, “female”, “non-binary”, and “unspecified”.

name.pronouns

Valid values are “he/him”, “she/her”, “they/them”, or “other”. Optional: May also be an empty string if unknown or not specified.

name.preferredFirst

Optional: May also be an empty string if unknown or not specified.

name.preferredLast

Optional: May also be an empty string if unknown or not specified.

Example Request

An example body might look like the following:

{
  "name": {
    "first": "Timothy",
    "last": "Fitzsimmons",
    "previous": "",
    "pronouns": "he/him",
    "preferredFirst": "Tim",
    "preferredLast": ""
  },
  "home": {
    "address": "1100 Mandan Road",
    "city": "Victoria",
    "province": "BC",
    "country": "Canada",
    "postal": "V8S 4N3"
  },
  "phones": [
    "2505727938"
  ],
  "ancestry": {},
  "education": {
    "grade": "11",
    "iep": false,
    "school": ""
  },
  "enrolments": [
    {
      "course": {
        "deleted": false,
        "desc": "",
        "fullname": "Science 10",
        "id": "7d396156-cd17-4a0f-9ad5-0b3a0038f57a",
        "isSyncFailing": false,
        "lmsId": "33319",
        "program": "DL-S",
        "shortname": "SC-10",
        "state": "open",
        "teachers": [
          {
            "lmsId": "52155",
            "name": "Andrew Wilson"
          }
        ],
        "type": "DL"
      },
      "state": "requested",
      "notes": {},
      "dates": {
        "requested": "2023-06-20T00:42:38.953Z"
      }
		}
  ],
  "contacts": [
    {
      "name": "test",
      "email": "[email protected]"
    }
  ],
  "email": "[email protected]",
  "birthdate": "2006-03-24T20:00:00.000Z",
  "gender": "male"
}

Implementation Notes

• The registration form has more rigorous client-side validation checking than the internal endpoint. The endpoint may accept data that the registration form itself would not generate. This should not cause functional issues with the SMS, but if you see unexpected behaviour please reach out to support.
• If the student’s email is already in use by an account, the API endpoint will return an “email in use” error.
• Emails (for the student and contacts) must be valid email addresses.
• To see further examples of different fields or how the registration form constructs students, you can use your browser’s developer tools and create students in the course registration interface, then observe the request payload that is sent.
• Only enrolment requests should be created with this endpoint.