System information for SMS providers for business as usual. Outages, Incident notifications, xsd and master reference data.
This page provides information for SMS developers – please bookmark to keep up to date with any system issues and alerts
As an SMS vendor the compliance environment is available for testing of any updates that affect the UIP functionality.
If you have any issues or incidents to report regarding the UIP system, email UIP.DataCollection@education.govt.nz.
The current version of the XSD file [ZIP; 5KB] (version 5) is available in a zipped file, which will need to be downloaded, saved and unzipped. Please contact UIP.DataCollection@education.govt.nz if you have issues accessing the document.
If you have any issues downloading any documents please contact us at UIP.DataCollection@education.govt.nz.
UIP Master reference data
This is a full listing of the master reference data lists used within the UIP system.
List | Used in event message | Full list | Comments | |
---|---|---|---|---|
Completion Code | Learner Component Completion events | Code | Name | Full list used in SDR, 1-4 have the names simplified for UIP and 9 added for use in UIP only. |
1 | Still to complete | |||
2 | Pass | |||
3 | Fail | |||
4 | Withdrawn | |||
9 | Finished | |||
Country of Citizenship | Learner Residency events | Education Counts website - country of citizenship codes | ||
Ethnicity | Learner Demographic events | Education Counts website - ethnic group codes | Level 3 codes should be used. | |
Fee paying status code | Learner Component Enrolment events | Code | Name | Full list used in SDR, these three are the only options used in UIP. |
2 | International Fee-Paying (IFP) Students (including Australian citizens and New Zealand permanent residents who are residing overseas) | |||
3 | Domestic Full Fee Paying Students | |||
12 | Other (including other contracts) | |||
Gender | Learner Identity events | Code | Name | If your SMS has an interface with NSI use only “M” and “F” |
M | Male | |||
F | Female | |||
I | Indeterminate | |||
X | if stated on NZ and Australian passport | |||
O | Other | |||
U | Unknown | |||
Immigration Status (Visa type) | Learner Residency events | Code | Name | |
11 | Consular | |||
12 | Diplomatic | |||
13 | Limited | |||
14 | Military | |||
15 | Official | |||
16 | Permanent Resident | |||
17 | Resident | |||
18 | Returning Residents | |||
19 | Student | |||
20 | Transit | |||
21 | Visitors | |||
22 | Work | |||
Iwi | Learner Demographic events | Education Counts website - Iwi codes | The 4 character codes from the region tables should be used. | |
NZQF Qualification Code | Learner Provider Enrolment events and Qualification Completion events | NZQA website - qualifications search | ||
NZSCED (Field of Study) | Component Information events | Education Counts - NZSCED | Detailed Fields of Study should be used e.g. ‘010101’ for Mathematics or ‘010303’ for Astronomy | |
Qualification Source codes | Learner Provider Enrolment events and Qualification Completion events | Code | Name | |
11 | NZQF | |||
12 | Provider |
If you have any issues downloading any documents please contact us at UIP.DataCollection@education.govt.nz.
Compliant Providers
This is a list of TEO (UIP Providers) who are now compliant with the UIP Data Collection.
As TEOs (UIP Providers) become compliant with UIP data collection, we will publish their details here.