Create a Learner

Create a Learner

Header Parameters
EID string — REQUIRED Enter the EDUMIS (Organisation) ID

Request Body
learnerLocalId string — REQUIRED Possible values: 1 ≤ length ≤ 20 Learner Local ID A code which uniquely identifies the learner within each TEO, as captured in a TEO’s TMS system. The Learner Local ID must remain constant for the learner throughout their enrolment history at your organisation. Length: 20 Type: String Guidance: This number must be the unique value generated by each TEO via their TMS.
identity object — REQUIRED nationalStudentNumber int32 — REQUIRED National Student Number A number which uniquely identifies the learner. The NSN must remain constant for the learner throughout their enrolment at your or any other organisation. The NSN reported in the Learner file must match the NSN used for other collections (e.g., Course Enrolment). The NSN is part of the NSI database system maintained by the Ministry of Education. Type: Integer Guidance: This number must be the value generated by the National Student Index (NSI) for the learner. dateOfBirth date — REQUIRED Date of Birth The day, month, and year of birth of the learner. Type: Date Guidance: 2024-04-08 You must use ISO-8601 for your dates. nameIdCode string — REQUIRED Possible values: 1 ≤ length ≤ 5 Name ID Code The first four characters of a learner’s surname plus initial of first legal name. If the learner does not have a first name, use the first five characters for the surname. This is new data is required for validating the identity of a learner and their associated NSN. Length: 5 Type: String Guidance: The value is generated by your organisation from the learner’s name. The NAMEID is generated from the first four characters of the surname and the first initial of forename 1. Characters must be capitalised. If the surname is less than 4 characters, then blanks must be inserted before forename initial. The initial must be in the fifth position. For example: › LEE A for Andrew Lee › VAN M for Michael van der Hum › DE WP for Peter de Wittering › KHSID for Khsithesh Devi › O’COB for Brian O’Connor Note: The NAMEID must match the equivalent NAMEID from either the main name or an alternative name on the NSN reported. gender string — REQUIRED Possible values: 1 ≤ length ≤ 1 Gender A code to identify the gender of a learner. Length: 1 Type: String Guidance: Select a value from the list below M: Male / Tāne F: Female / Wahine D: Another gender / He ira kē anō
irdNumber string Possible values: length ≤ 11 IrdNumber A code to identify the IrdNumber of a learner. Length: 11 Type: String Guidance: IRD numbers are either eight or nine digits with dashes e.g., 123-456-789. Please enter leading zero in the first box if your IRD number is only 8 digits. only provide an IRD number for a learner may meet the eligibility criteria for Fees Free at the time of enrolment. However, in situations where you know they are not eligible, you will not need to collect their IRD number.For example, where a learner: has received a Fees Free entitlement previously (e.g.first-year Fees Free) is not studying an eligible programme does not meet prior study criteria
demographics object — REQUIRED countryOfCitizenship string — REQUIRED Possible values: 1 ≤ length ≤ 4 Country of Citizenship The country of citizenship of a learner. This field is required for determining non-domestic learner funding. Note: · Citizenship status must be kept up to date · TEC will date stamp the receipt of an update for validation and reporting requirements · There is no backdating of this field Length: 3 Type: String Guidance: Select a value from the country of citizenship classification. Refer to the DXP Data Classifications Appendices. disabilityStatus int32 — REQUIRED Disability Status Indicates the disability status of a learner. This field aligns to the collection of the new disability data on the enrolment form. Type: Integer Guidance: Select a value from the list below. 1: Yes 2: No 3: Prefer not to say disabilitySupportNeeds int32[] Disability Support Needs Seven fields to support multiple responses indicating the disability support a learner requires. This field aligns to the collection of the new disability data on the enrolment form. Type: Integer array Guidance: Select a value from the list below. 1: Access to assistive technology (e.g., for reading, writing, communication). 2: Accessible format resources for course content. 3: Mobility and transport (e.g., navigator support to help movement around campus, mobility carparks, personal emergency evacuation plan). 4: New Zealand Sign Language Interpreter. 5: Support with reading, writing, and communicating in learning sessions, exams, and assessments. 6: Other learning or disability support. 7: No, I do not need support at this time. If the Disability Status is Yes, then at least one disability support need must be supplied. ethnicity string[] — REQUIRED Ethnicity A code to indicate the ethnicity of a learner. Up to six ethnic codes can be entered in this field. The codes identify the ethnic group or groups to which a learner belongs. Type: String array Guidance: Select a value or values from the Statistics NZ Ethnicity New Zealand Standard Classification 2005V2.1.0. At least one value must be reported. The Ethnicity classification is available at NZ Statistics - Ethnicity New Zealand Standard Classification 2005V2.1.0. They are also listed in the DXP Data Classifications Appendices. iwiAffiliation string[] Iwi Affiliation A code to indicate the iwi affiliation of a learner. If a learner has more than one affiliation, then up to six Iwi can be recorded. Type: String array Guidance: Select a value or values from the Statistics NZ Iwi and iwi-related groups statistical classificationV2.1.0. An entry must be reported in the first field where the ethnic group is “0211”. The Iwi classification is available at NZ Statistics - Iwi and iwi-related groups statistical classificationV2.1.0. They are also listed in the DXP Data Classifications Appendices. isEnglishSecondLanguage boolean — REQUIRED Is English Second Language A True/False flag that indicates whether English is a second language for the learner. Type: Boolean Guidance: Select a value from below: True: English is a second language for the learner False: English is not a second language for the learner disabilityServicesAccessedIndicator boolean — REQUIRED Disability Services Accessed Indicator A code to indicate whether a student has accessed disability services Type: Boolean Type of enrolment: D Guidance: Select a value from the list below. True: Disability services accessed. False: Disability services not accessed.
educationHistory object — REQUIRED lastSecondarySchoolAttended int32 — REQUIRED Last Secondary School Attended A code to identify the last secondary school attended by the learner. Type: Integer Guidance: Select a value from the secondary school codes classification. The Secondary School Codes are available at the Education Counts website - Secondary School Codes. They are also listed in the DXP Data Classifications Appendices. overseasCountryCode string Overseas Country Code A unique code defined by that identifies the country in which the learner last attended school. Type: String Guidance: Select a value from the NZ Statistics: Country – New Zealand Standards Classification 1999 – 4 numeric V15.0. Must be supplied if the learner’s last school was not in New Zealand. New Zealand cannot be selected. We collect at level 3. The country classification is available at NZ Statistics: Country – New Zealand Standards Classification 1999 – 4 numeric V15.0. They are also listed in the DXP Data Classifications Appendices. lastYearAtSecondarySchool int32 Last Year at Secondary School The year in which the learner finished their secondary school education. Type: Integer Guidance: Enter the year in the format YYYY - e.g., 2023. highestSecondarySchoolQualification string — REQUIRED Possible values: 1 ≤ length ≤ 2 Highest Secondary School Qualification A code to show the highest secondary school qualification attained by the learner. Length: 2 Type: String Guidance: Select a value from the list below. 0: No formal secondary school qualification 11: 14 or more credits at any level 12: NCEA Level 1 or School Certificate 13: NCEA Level 2 or 6th Form Certificate 14: University Entrance 15: NCEA Level 3 or Bursary or Scholarship 9: Overseas qualification (incl. International Baccalaureate & Cambridge Exams) 98: Other 99: Not known mainActivityAt1OctoberInYearPriorToFormalEnrolment string — REQUIRED Possible values: 1 ≤ length Main Activity at 1 October in Year Prior to Formal Enrolment The main activity or occupation for the learner on 1 October of the year prior to enrolling a learner at your organisation. This field is not required to be changed upon re-enrolment if the duration between the end of the previous enrolment and the re-enrolment is 12 months or less. If a learner returns to the same TEO after not being enrolled for a period of more than 12 months, this field should be updated to reflect the learner’s most recent main activity on 1 October of the year before. If the learner enrolled for the first time between 1 October and 31 December of the current year, then report the main activity on 1 October of the current year. Type: String Guidance: Select a value from the list below. 01: Secondary school student 02: Non-employed or beneficiary (excluding retired) 03: Wage or salary worker 04: Self-employed 05: University student 06: Polytechnic student 07: College of Education student 08: House person or retired 09: Overseas (irrespective of occupation) 11: Private Training Establishment student 12: Wānanga student Note: The classification of ’99 – other’ has been removed and may only be used historically. firstYearOfTertiaryEducation int32 First Year of Tertiary Education The year in which a learner first enrolled in any “quality assured” qualification: · at a TEO in New Zealand or overseas, or · in the Foundation Year at the University of the South Pacific, or · at a registered Private Training Establishment. Enrolment in STAR, community, or other non-formal education does not count for first year purposes. Type: Integer Guidance: Enter the year in the format YYYY - e.g., 2023. This field is required if the learner is a New Zealand or Australian citizen or resident.

Responses
201 The operation returned successfully and a new resource was created. Schema — OPTIONAL learnerLocalId string Possible values: 1 ≤ length ≤ 20 Learner Local ID A code which uniquely identifies the learner within each TEO, as captured in a TEO’s TMS system. The Learner Local ID must remain constant for the learner throughout their enrolment history at your organisation. Length: 20 Type: String Guidance: This number must be the unique value generated by each TEO via their TMS. identity object nationalStudentNumber int32 National Student Number A number which uniquely identifies the learner. The NSN must remain constant for the learner throughout their enrolment at your or any other organisation. The NSN reported in the Learner file must match the NSN used for other collections (e.g., Course Enrolment). The NSN is part of the NSI database system maintained by the Ministry of Education. Type: Integer Guidance: This number must be the value generated by the National Student Index (NSI) for the learner. dateOfBirth date Date of Birth The day, month, and year of birth of the learner. Type: Date Guidance: 2024-04-08 You must use ISO-8601 for your dates. nameIdCode string Possible values: 1 ≤ length ≤ 5 Name ID Code The first four characters of a learner’s surname plus initial of first legal name. If the learner does not have a first name, use the first five characters for the surname. This is new data is required for validating the identity of a learner and their associated NSN. Length: 5 Type: String Guidance: The value is generated by your organisation from the learner’s name. The NAMEID is generated from the first four characters of the surname and the first initial of forename 1. Characters must be capitalised. If the surname is less than 4 characters, then blanks must be inserted before forename initial. The initial must be in the fifth position. For example: › LEE A for Andrew Lee › VAN M for Michael van der Hum › DE WP for Peter de Wittering › KHSID for Khsithesh Devi › O’COB for Brian O’Connor Note: The NAMEID must match the equivalent NAMEID from either the main name or an alternative name on the NSN reported. gender string Possible values: 1 ≤ length ≤ 1 Gender A code to identify the gender of a learner. Length: 1 Type: String Guidance: Select a value from the list below M: Male / Tāne F: Female / Wahine D: Another gender / He ira kē anō irdNumber string — OPTIONAL Possible values: length ≤ 11 IrdNumber A code to identify the IrdNumber of a learner. Length: 11 Type: String Guidance: IRD numbers are either eight or nine digits with dashes e.g., 123-456-789. Please enter leading zero in the first box if your IRD number is only 8 digits. only provide an IRD number for a learner may meet the eligibility criteria for Fees Free at the time of enrolment. However, in situations where you know they are not eligible, you will not need to collect their IRD number.For example, where a learner: has received a Fees Free entitlement previously (e.g.first-year Fees Free) is not studying an eligible programme does not meet prior study criteria demographics object countryOfCitizenship string Possible values: 1 ≤ length ≤ 4 Country of Citizenship The country of citizenship of a learner. This field is required for determining non-domestic learner funding. Note: · Citizenship status must be kept up to date · TEC will date stamp the receipt of an update for validation and reporting requirements · There is no backdating of this field Length: 3 Type: String Guidance: Select a value from the country of citizenship classification. Refer to the DXP Data Classifications Appendices. disabilityStatus int32 Disability Status Indicates the disability status of a learner. This field aligns to the collection of the new disability data on the enrolment form. Type: Integer Guidance: Select a value from the list below. 1: Yes 2: No 3: Prefer not to say disabilitySupportNeeds int32[] — OPTIONAL Disability Support Needs Seven fields to support multiple responses indicating the disability support a learner requires. This field aligns to the collection of the new disability data on the enrolment form. Type: Integer array Guidance: Select a value from the list below. 1: Access to assistive technology (e.g., for reading, writing, communication). 2: Accessible format resources for course content. 3: Mobility and transport (e.g., navigator support to help movement around campus, mobility carparks, personal emergency evacuation plan). 4: New Zealand Sign Language Interpreter. 5: Support with reading, writing, and communicating in learning sessions, exams, and assessments. 6: Other learning or disability support. 7: No, I do not need support at this time. If the Disability Status is Yes, then at least one disability support need must be supplied. ethnicity string[] Ethnicity A code to indicate the ethnicity of a learner. Up to six ethnic codes can be entered in this field. The codes identify the ethnic group or groups to which a learner belongs. Type: String array Guidance: Select a value or values from the Statistics NZ Ethnicity New Zealand Standard Classification 2005V2.1.0. At least one value must be reported. The Ethnicity classification is available at NZ Statistics - Ethnicity New Zealand Standard Classification 2005V2.1.0. They are also listed in the DXP Data Classifications Appendices. iwiAffiliation string[] — OPTIONAL Iwi Affiliation A code to indicate the iwi affiliation of a learner. If a learner has more than one affiliation, then up to six Iwi can be recorded. Type: String array Guidance: Select a value or values from the Statistics NZ Iwi and iwi-related groups statistical classificationV2.1.0. An entry must be reported in the first field where the ethnic group is “0211”. The Iwi classification is available at NZ Statistics - Iwi and iwi-related groups statistical classificationV2.1.0. They are also listed in the DXP Data Classifications Appendices. isEnglishSecondLanguage boolean Is English Second Language A True/False flag that indicates whether English is a second language for the learner. Type: Boolean Guidance: Select a value from below: True: English is a second language for the learner False: English is not a second language for the learner disabilityServicesAccessedIndicator boolean Disability Services Accessed Indicator A code to indicate whether a student has accessed disability services Type: Boolean Type of enrolment: D Guidance: Select a value from the list below. True: Disability services accessed. False: Disability services not accessed. educationHistory object lastSecondarySchoolAttended int32 Last Secondary School Attended A code to identify the last secondary school attended by the learner. Type: Integer Guidance: Select a value from the secondary school codes classification. The Secondary School Codes are available at the Education Counts website - Secondary School Codes. They are also listed in the DXP Data Classifications Appendices. overseasCountryCode string — OPTIONAL Overseas Country Code A unique code defined by that identifies the country in which the learner last attended school. Type: String Guidance: Select a value from the NZ Statistics: Country – New Zealand Standards Classification 1999 – 4 numeric V15.0. Must be supplied if the learner’s last school was not in New Zealand. New Zealand cannot be selected. We collect at level 3. The country classification is available at NZ Statistics: Country – New Zealand Standards Classification 1999 – 4 numeric V15.0. They are also listed in the DXP Data Classifications Appendices. lastYearAtSecondarySchool int32 — OPTIONAL Last Year at Secondary School The year in which the learner finished their secondary school education. Type: Integer Guidance: Enter the year in the format YYYY - e.g., 2023. highestSecondarySchoolQualification string Possible values: 1 ≤ length ≤ 2 Highest Secondary School Qualification A code to show the highest secondary school qualification attained by the learner. Length: 2 Type: String Guidance: Select a value from the list below. 0: No formal secondary school qualification 11: 14 or more credits at any level 12: NCEA Level 1 or School Certificate 13: NCEA Level 2 or 6th Form Certificate 14: University Entrance 15: NCEA Level 3 or Bursary or Scholarship 9: Overseas qualification (incl. International Baccalaureate & Cambridge Exams) 98: Other 99: Not known mainActivityAt1OctoberInYearPriorToFormalEnrolment string Possible values: 1 ≤ length Main Activity at 1 October in Year Prior to Formal Enrolment The main activity or occupation for the learner on 1 October of the year prior to enrolling a learner at your organisation. This field is not required to be changed upon re-enrolment if the duration between the end of the previous enrolment and the re-enrolment is 12 months or less. If a learner returns to the same TEO after not being enrolled for a period of more than 12 months, this field should be updated to reflect the learner’s most recent main activity on 1 October of the year before. If the learner enrolled for the first time between 1 October and 31 December of the current year, then report the main activity on 1 October of the current year. Type: String Guidance: Select a value from the list below. 01: Secondary school student 02: Non-employed or beneficiary (excluding retired) 03: Wage or salary worker 04: Self-employed 05: University student 06: Polytechnic student 07: College of Education student 08: House person or retired 09: Overseas (irrespective of occupation) 11: Private Training Establishment student 12: Wānanga student Note: The classification of ’99 – other’ has been removed and may only be used historically. firstYearOfTertiaryEducation int32 — OPTIONAL First Year of Tertiary Education The year in which a learner first enrolled in any “quality assured” qualification: · at a TEO in New Zealand or overseas, or · in the Foundation Year at the University of the South Pacific, or · at a registered Private Training Establishment. Enrolment in STAR, community, or other non-formal education does not count for first year purposes. Type: Integer Guidance: Enter the year in the format YYYY - e.g., 2023. This field is required if the learner is a New Zealand or Australian citizen or resident.
400 Bad request. Check errors and codes for more detail. Schema — OPTIONAL type string — OPTIONAL title string — OPTIONAL status int32 — OPTIONAL detail string — OPTIONAL instance string — OPTIONAL errors object — OPTIONAL
401 Unauthorized Schema — OPTIONAL type string — OPTIONAL title string — OPTIONAL status int32 — OPTIONAL detail string — OPTIONAL instance string — OPTIONAL errors object — OPTIONAL
429 Rate Limiting may apply. Refer to Retry-After header Schema — OPTIONAL type string — OPTIONAL title string — OPTIONAL status int32 — OPTIONAL detail string — OPTIONAL instance string — OPTIONAL