Upload
nguyendieu
View
221
Download
1
Embed Size (px)
Citation preview
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 1 of 69
Table of Contents
Revision History ................................................................................................................. 2 Purpose of this Document ................................................................................................... 4
Employment and Additional Data XML Dialogues ........................................................... 4 Typical Dialogues ........................................................................................................... 4
Employment and Additional Data XML Specification ...................................................... 5 1. Objects ................................................................................................................. 6 1.1 OrganizationEmployment .................................................................................... 6
1.2 WorkAssignment ................................................................................................. 6 1.3 ClassroomComposition ........................................................................................ 7
1.4 EducatorCertification ........................................................................................... 8 2.0 Elements ............................................................................................................. 11 2.1 PersonIdentification ........................................................................................... 11 2.2 PersonInfo .......................................................................................................... 11
2.3 EmploymentInfo ................................................................................................ 18 2.4 WorkAssignmentInfo ......................................................................................... 25
2.5 ClassroomInfo .................................................................................................... 32 2.6 CertificateInfo .................................................................................................... 33 3. Queries ............................................................................................................... 38
3.1 QueryByEmployee ............................................................................................. 38 3.2 QueryByEmployer ............................................................................................. 39
3.3 QueryBySchool .................................................................................................. 41
4. Message Infrastructure ....................................................................................... 43
4.1 EAD_Message ................................................................................................... 43 4.2 EAD_Header ...................................................................................................... 44
4.3 EAD_Event ........................................................................................................ 45 4.4 EAD_Request .................................................................................................... 45 4.5 EAD_Response .................................................................................................. 46
4.6 EAD_Ping .......................................................................................................... 48 Appendix A – Subject Codes ............................................................................................ 49 Appendix B – Country Codes ........................................................................................... 57
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 2 of 69
Revision History
Date Version Changes 2013 June 21 Pre-
release
First draft by David Hodgson
2013 Oct 17 1.0 Incorporate business area and sector feedback
2014 Feb 7 1.1 Changed Subject code in ClassRoomInfo element to be
optional. Updated examples.
2014 Feb 11 1.2 Updated K12 work assignment element to consolidate
Counselling categories. Updated EmploymentPosition code
values to generalize Counselor, Coordinator, and Consultant
positions.
2014 Feb 12 1.3 Added effective Start and End dates to
WorkAssignmentInfo and ClassroomInfo elements.
2014 April 9 1.4 Updated schema based on developer feedback.
2014 April 15 1.5 Updated Subject code table.
2014 April 21 1.6 Updated Classification code table.
2014 April 23 1.7 Formatted EmploymentInfo element.
2014 May 23 1.8 Corrected ClassroomInfo example.
2014 May 26 1.9 Removed OtherAllowance data element.
2014 June 5 2.0 Re-worked element 2.5 (ClassroomInfo).
2014 June 12 2.1 Updated QueryByEmployee and QueryByEmployer
objects.
2014 June 19 2.2 Changed PersonId field in PersonIdentification (element
2.1) from optional to required. Added QueryBySchool
(element 3.3).
2014 July 8 2.3 Fixed Composition / Subject element and example.
2014 July 17 2.4 Added definitions and additional example to
WorkAssignmentInfo element section.
2014 Aug 19 2.5 Revised Appendix A Kindergarten course descriptions.
2014 Oct 10 2.6 Added “Delete” event action (EAD_Event).
2015 May 21 2.7 Added Appendix B (Country Codes).
2015 June 9 2.8 Updated Appendix A (added courses 33, 35, 36, 39, 40, 43);
updated aboriginal status element documentation; added
definition of assessment coordinator.
2015 June 29 2.9 Added K-9 Arts Education course codes to Appendix A.
2015 Oct 1 3.0 Added complete ClassroomComposition example.
2015 Dec 14 3.1 Deprecated PositionSubtype codes 01-03.
2016 Jan 11 3.2 Gender is now mandatory in PersonInfo element; SIN is no
longer collected; PersonAddress element should not be
submitted for educators employed by school division; Email
address is now mandatory; added object 1.4
(EducatorCertification) and element 2.6 (CertificateInfo).
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 3 of 69
2016 Jan 20 3.2 Updated Appendix A & B.
2016 Feb 2 3.2 Corrected typos.
2016 Feb 11 3.2 Updated Appendix A.
2016 Mar 1 3.2 PersonInfo element in OrganizationEmployment object is
now mandatory (to ensure email address is collected).
2016 Mar 4 3.2 CertificateInfo element in EducatorCertification object is
now optional (to allow for demographic changes without re-
submitting educator certificate information).
2016 April 1 3.2 PersonInfo / Name element is now repeatable to
accommodate acceptance of historical names.
2016 May 2 3.2 Added Programme d'études interdisciplinaire K-2 course
codes and Band 5-9 course codes to Appendix A.
2016 June 13 3.2 Updated Appendix A.
2016 July 19 3.2 Corrected multi-grade example on page 33.
2016 Aug 19 3.2 Updated Appendix A (intensive and post-intensive French
subject codes).
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 4 of 69
Purpose of this Document
This document presents the format of XML for exchanging Employment and Additional
Data between partners. It does not address the technology of transmitting and receiving
messages (i.e. transport layer).
Employment and Additional Data XML Dialogues
An XML dialogue, whether real-time or batch, consists of one or more messages sent
from an employer (e.g. school or school division) to the Ministry of Education, and one
or more messages sent from the Ministry of Education back to the employer (at
minimum, the Ministry of Education returns acknowledgement that it received the
original messages).
Note that the dialogues presented below imply nothing about the timing of sending
messages – they are the same regardless of whether the employer accumulates messages
and sends them in a batch or sends them real-time.
Message types include:
Events (new or changed data)
Requests for data
Responses to requests and events
Typical Dialogues
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 5 of 69
Employment and Additional Data XML Specification
The Ministry of Education (MOE) Employment and Additional Data XML Specification
defines how XML is structured for communication between employers and The Ministry
of Education. It was designed using the School Interoperability Framework (SIF)
Implementation Specification (see www.sifinfo.org) as a starting point, but is not
compliant with SIF.
The MOE Employment and Additional Data XML Specification defines the structure of
each object. Each object consists of one or more elements, some of which contain
additional elements within them. Elements may also contain attributes that define the
element. An element that contains elements and/or an attributes is called a complex
element. An element that does not is called a simple element.
Elements and attributes are character strings unless otherwise indicated. All dates are in
the format YYYY-MM-DD. Other restrictions on the format and/or contents of the
strings are indicated in the specifications below. Any element or attribute that is not
considered valid will be rejected and could cause the rejection of the entire object that
contains it. Syntax for elements and attributes follows standard XML syntax.
Note that each object is assigned a RefId (reference ID), which, for event messages, must
be unique within the XML message, so that responses can refer to it. A response, whether
it is an error message or data returned (e.g., return of an employee number), will use the
same RefId as the object it is responding to.
Queries are also assigned a RefId, which must be unique within the request XML
message. If a query returns many objects (e.g. query of all employees of an organization)
all the returned objects will include the RefId of the query.
In the Educator Employment and Additional Data XML Specification:
For an element A included in a complex element B, “required” means that if element
B is included in an object, it must include element A within it. However, if element B
is not included in the object, element A is not required.
For an element A that is included in an object without being part of a complex
element, “required” means that element A must be included in the object.
For an attribute A of an element B, “required” means that if element B is included in
an object, attribute A must be included and given a value.
Elements can have multiple values only if the specification indicates that they are
“repeatable”.
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 6 of 69
1. Objects
The following objects support transmission of data between employers and the Ministry
of Education. Employers send objects to the Ministry of Education with action codes to
indicate whether each object is to be created, updated or deleted (with limitations on what
can be deleted). See section 4.3 EAD_Event for more information on action codes.
Objects are also used to send data from the Ministry of Education to employers, on
request.
Each object consists of a RefId plus one or more elements. The RefId is used to refer to
the object in any messages returned, and must be unique within an event XML message
(for responses to queries, the RefId is used to identify the query the object is a response
to). Elements without a description in this section are complex elements, which are
described in section 2 Elements.
1.1 OrganizationEmployment
This object allows an employer to describe their employees and related employment
information, or to update employee and employment information.
Element Attribute Status Description/Notes
OrganizationEmployment
RefId Required The reference ID for returning
messages.
EmployerId Required Employer ID, e.g. school
division’s department assigned
number.
PersonIdentification Required Element 2.1
PersonInfo Required Element 2.2
EmploymentInfo Optional Element 2.3
1.2 WorkAssignment
This object allows an employer to describe an employee’s work assignment.
Element Attribute Status Description/Notes
WorkAssignment
RefId Required The reference ID for returning
messages.
EmployerId Required Employer ID, e.g. school
division’s department assigned
number.
PersonIdentification Required Element 2.1
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 7 of 69
PersonInfo Optional Element 2.2
WorkAssignmentInfo Required and
Repeatable
Element 2.4
1.3 ClassroomComposition
This object allows an employer to describe an employee’s classroom composition.
Element Attribute Status Description/Notes
ClassroomComposition
RefId Required The reference ID for returning
messages.
EmployerId Required Employer ID, e.g. school
division’s department assigned
number.
PersonIdentification Required Element 2.1
ClassroomInfo Optional and
Repeatable
Element 2.5
Example
Complete example for submitting classroom composition information for an educator:
<EAD_Message xmlns="http://www.k12.gov.sk.ca/xsd/sl/1.x/EADMessage.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.k12.gov.sk.ca/xsd/sl/1.x/EADMessage.xsd
http://www.k12.gov.sk.ca/xsd/sl/1.x/EADMessage.xsd">
<EAD_Event>
<EAD_Header>
<EAD_MsgId>@SL_MsgId@</EAD_MsgId>
<EAD_Date>2014-08-12</EAD_Date>
<EAD_Time Zone="UTC-06:00">13:52:25</EAD_Time>
<EAD_SourceId>9990000</EAD_SourceId>
</EAD_Header>
<EAD_ObjectData>
<EAD_EventObject ObjectName="ClassroomComposition"
Action="Add">
<ClassroomComposition RefId="1">
<EmployerId>9990000</EmployerId>
<PersonIdentification>
<PersonId Type="01">1234567</PersonId>
<BirthDate>1981-07-11</BirthDate>
</PersonIdentification>
<ClassroomInfo>
<SchoolDAN>9996101</SchoolDAN>
<ClassroomIdentifier>C01</ClassroomIdentifier>
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 8 of 69
<MultiGrade Code="No"/>
<StartDate>2015-08-27</StartDate>
<EndDate>2016-06-30</EndDate>
<Composition>
<Subject Code="201"/>
<StudentCount>19</StudentCount>
</Composition>
</ClassroomInfo>
<ClassroomInfo>
<SchoolDAN>9996101</SchoolDAN>
<ClassroomIdentifier>C02</ClassroomIdentifier>
<MultiGrade Code="Yes"/>
<StartDate>2015-08-27</StartDate>
<EndDate>2016-06-30</EndDate>
<Composition>
<Subject Code="200"/>
<StudentCount>13</StudentCount>
</Composition>
<Composition>
<Subject Code="300"/>
<StudentCount>10</StudentCount>
</Composition>
</ClassroomInfo>
</ClassroomComposition>
</EAD_EventObject>
</EAD_ObjectData>
</EAD_Event>
</EAD_Message>
1.4 EducatorCertification
This object allows an employer to describe an employee’s professional certification
standing.
Element Attribute Status Description/Notes
EducatorCertification
RefId Required The reference ID for returning
messages.
PersonIdentification Required Element 2.1
PersonInfo Optional Element 2.2
CertificateInfo Optional and
Repeatable
Element 2.6
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 9 of 69
Example
Complete example for submitting professional certification information for a K12
educator:
<EAD_Message xmlns="http://www.k12.gov.sk.ca/xsd/sl/1.x/EADMessage.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.k12.gov.sk.ca/xsd/sl/1.x/EADMessage.xsd
http://www.k12.gov.sk.ca/xsd/sl/1.x/EADMessage.xsd">
<EAD_Event>
<EAD_Header>
<EAD_MsgId>{36789AD0-BF60-4F67-A1F9-07964B8CC06D}</EAD_MsgId>
<EAD_Date>2015-12-16</EAD_Date>
<EAD_Time Zone="UTC-06:00">9.53.03</EAD_Time>
<EAD_SourceId>1234567</EAD_SourceId>
</EAD_Header>
<EAD_ObjectData>
<EAD_EventObject ObjectName="EducatorCertification" Action="Add">
<EducatorCertification RefId="1">
<PersonIdentification>
<PersonId Type="01">7654321</PersonId>
<BirthDate>1932-09-17</BirthDate>
</PersonIdentification>
<PersonInfo>
<Name>
<LastName>Maiden</LastName>
<FirstName>Teacher</FirstName>
<StartDate>1952-06-19</StartDate>
<EndDate>1960-06-01</EndDate>
</Name>
<Name>
<LastName>Married</LastName>
<FirstName>Teacher</FirstName>
<StartDate>1960-06-01</StartDate>
</Name>
<Email Type="Alternate">[email protected]</Email>
<Demographics>
<Gender>F</Gender>
</Demographics>
<PersonAddress>
<Address Type="Mailing">
<Street>
<Line1>BOX 1</Line1>
</Street>
<City>Rouleau</City>
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 10 of 69
<StatePr Code="SK"/>
<Country Code="CA"/>
<PostalCode>S0G 4H0</PostalCode>
</Address>
</PersonAddress>
<PhoneNumber Format="NA" Type="Work">306-123-
4567</PhoneNumber>
<PhoneNumber Format="NA" Type="Home">306-123-
7890</PhoneNumber>
</PersonInfo>
<CertificateInfo Type=”01”>
<CertificateType Code="02"/>
<Provisional Code="Yes"/>
<Condition Code="01"/>
<IssueDate>2015-11-19</IssueDate>
<StartDate>2015-11-19</StartDate>
<EndDate>2016-11-19</EndDate>
<EndorsedSubject Code="01"/>
<EndorsedSubject Code="02"/>
</CertificateInfo>
<CertificateInfo Type=”01”>
<CertificateType Code="01"/>
<Provisional Code="No"/>
<Condition Code="01"/>
<IssueDate>2016-11-02</IssueDate>
<StartDate>2016-11-02</StartDate>
</CertificateInfo>
</EducatorCertification>
</EAD_EventObject>
</EAD_ObjectData>
</EAD_Event>
</EAD_Message>
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 11 of 69
2.0 Elements
These elements are used within the objects described in section 1 Objects.
2.1 PersonIdentification
This element is used to uniquely identify an individual. If BirthDate does not match the
individual’s birth date in the ministry’s database, the object containing this element is
rejected.
Element Attribute Status Description/Notes
PersonIdentification Identifies an individual.
PersonId Required Individual’s educator certificate
number or Saskatchewan Learning ID
(clients and non-clients). For non-K12
educators, a Learning ID will be
generated and returned for individuals
that do not exist in the database. If
possible, use this identifier to refer to
the individual in the future.
Type Required PersonId type (see below).
BirthDate Required The individual’s date of birth. Used to
ensure that the correct record is being
referenced. Cannot be used to update
the birth date of an existing individual.
PersonID Type Values
01 Educator Certificate Number (certified educators)
02
Saskatchewan Learning ID (all non-certified educator staff)
Example
<PersonIdentification>
<PersonId Type=”02”>123456789</PersonId>
<BirthDate>1983-10-31</BirthDate>
</PersonIdentification>
2.2 PersonInfo
This element is used to add or update demographic information about an individual.
Note that if the individual already exists in the ministry database, legal name and birth
date cannot be changed via XML, nor can gender unless its existing value is U
(unknown).
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 12 of 69
Element Attribute Status Description/Notes
PersonInfo Provides information about an
individual.
SIN Optional Social Insurance Number. Must be 9
digits and pass the check-digit edit.
Name Optional
and
Repeatable
Individual’s legal name.
Name/LastName Required Last name. Restricted to uppercase
and lowercase alpha characters,
hyphens (-), apostrophes ('), periods
(.) and spaces.
Name/FirstName Required First name. Restricted to same
allowable characters as LastName.
Name/MiddleName Optional Middle name or initial. Restricted to
same characters as LastName.
Name/Suffix Optional Name suffix like II, Jr., etc.
Restricted to same characters as
LastName.
Name/StartDate Optional Effective start date of the
individual’s name. Defaults to date of
XML submission if not specified.
Especially meaningful for tracking
name changes for non K12 educators.
Name/EndDate Optional Effective end date of the individual’s
name. Ignored if before StartDate.
Especially meaningful for tracking
name changes for non K12 educators.
Email Required
and
Repeatable
Individual’s email address(es). Must
contain exactly one @ character.
“Alternate” email address type is
only utilized by SPTRB, otherwise it
will be ignored.
Type Required Email type (see below)
Demographics Optional
Demographics/Gender Required Code that specifies the individual’s
gender (see below).
Demographics/
Deceased
Optional Information if the individual is
deceased
Code Required Deceased code (see below).
EffectiveDate Optional Death date if known.
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 13 of 69
Demographics/
AboriginalStatus
Optional The individual’s aboriginal status, if
applicable. Omit this element to
retain existing aboriginal status.
Code Required Aboriginal status code (see below)
PersonAddress Optional
and
Repeatable
The individual’s address information.
This element should not be submitted
for educators employed by a school
division, as educator address
information will now be managed by
the SPTRB.
PersonAddress/
Address
Required Detail of the individual’s address.
Type Optional Address type (see below). Defaults to
“permanent mailing address” if not
specified.
StartDate Optional Effective start date of the address.
Defaults to date of XML submission
if not specified.
EndDate Optional Effective end date of the address.
Ignored if before StartDate. Note: If
a new address is received, the old
address will be automatically end-
dated.
PersonAddress/
Address/Street
Optional Can be expressed as one or more
address lines, or as discrete elements
(e.g., street number, street name,
street type). The Ministry of
Education will always return address
as one or more address lines and will
also return address as discrete
elements if the address was received
as discrete elements. Street is
required for all address types except
PhysicalLand.
PersonAddress/
Address/Street/Line1
Optional Address line 1. Required if discrete
elements not included. If
PersonAddress/Address Type is
Permanent Physical, Municipality,
Line 1 or discrete elements is
required. If PersonAddress/Address
Type is Permanent Physical Land,
none of the municipal Street
elements will be accepted.
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 14 of 69
PersonAddress/
Address/Street/Line2
Optional Address line 2.
PersonAddress/
Address/Street/Line3
Optional Address line 3.
PersonAddress/
Address/Street/
Complex
Optional Name of the complex.
PersonAddress/
Address/Street/
StreetNumber
Optional The address number assigned to the
building.
PersonAddress/
Address/Street/
StreetPrefix
Optional Street prefix (e.g. SW, NE).
PersonAddress/
Address/Street/
StreetName
Optional The name of the street.
PersonAddress/
Address/Street/
StreetType
Optional The type of the street (e.g. Lane,
Blvd., Ave., etc.).
PersonAddress/
Address/Street/
StreetSuffix
Optional Street suffix (e.g. SE, NW).
PersonAddress/
Address/Street/
AptType
Optional Type of apartment (e.g. Suite).
PersonAddress/
Address/Street/
AptNumPrefix
Optional Apartment number prefix.
PersonAddress/
Address/Street/
AptNumber
Optional The number of the apartment.
PersonAddress/
Address/Street/
AptNumSuffix
Optional Apartment number suffix.
PersonAddress/
Address/QSec
Optional Quarter Section. Only accepted for
AddressType of Permanent Physical
Land. Either Quarter Section or
River Lot must be included if
AddressType is Permanent Physical
Land.
PersonAddress/
Address/Sec
Optional Section is Required if Quarter
Section is provided.
PersonAddress/
Address/RL
Optional River Lot. Only accepted for
AddressType of Permanent Physical
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 15 of 69
Land. Either River Lot or Quarter
Section must be included if
AddressType is Permanent Physical
Land.
PersonAddress/
Address/Twp
Optional Township is required if AddressType
is Permanent Physical Land.
PersonAddress/
Address/Rge
Optional Range is required if AddressType is
Permanent Physical Land.
PersonAddress/
Address/Mer
Optional Meridian is required if AddressType
is Permanent Physical Land.
PersonAddress/
Address/City
Required The city part of the address.
PersonAddress/
Address/StatePr
Optional The state or province code part of the
address (required for North American
addresses).
Code Required State or province code (as specified
by Canada Post).
PersonAddress/
Address/Country
Optional The country part of the address
(assumed to be Canada if not
provided).
Code Required Country code (see Appendix B)
PersonAddress/
Address/PostalCode
Optional The Canadian postal code or US ZIP
code. Required for mailing addresses
but not physical addresses.
PhoneNumber Optional
and
Repeatable
The individual’s phone number.
Format is (###) ###-#### for North
American phone numbers.
Format Required Code that specifies the format of the
phone number (see below)
Type Optional Phone number type (see below).
Defaults to “Home” if not specified.
StartDate Optional Effective start date of the phone
number. Defaults to date of XML
submission if not specified.
EndDate Optional Effective end date of the phone
number. Ignored if before StartDate.
Email Type Values
Primary Primary work email address (utilized by school divisions to submit
personnel information)
Alternate Alternate work email address (utilized by SPTRB)
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 16 of 69
Gender Values
M Male
F Female
U Unknown
Deceased Values
Yes Deceased
No Not deceased
Aboriginal Status Values
01 No (not Aboriginal)
02 Choose not to declare
03 Treaty/Registered/Status Indian
04 Non-Status Indian
05 Metis
06 Inuit/Inuk
Address Type Values
Mailing Permanent mailing address (default if not specified)
TempMailing Temporary mailing address
Physical Permanent physical address (no longer accepted)
PhysicalMun Permanent physical address – municipality
PhysicalLand Permanent physical address – land location
Physical Land Location Values
QSec Quarter Section
NW, NE, SW, SE
Sec Section
Numbers 1 through 36 and 36A
RL River Lot
Numbers 1 through 73
Twp Township
Numbers 1 through 67 and 19A, 27A, 42A, 43A, 45A, 46A, 47A, S, L
Rge Range
Numbers 1 through 34 and 13A, 21A, 24A, A, L
Mer Meridian
Numbers 1, 2, and 3 and S
Phone Number Format Values
NA North America
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 17 of 69
FF Free form
Phone Number Type Values
Home
Work
Home telephone number (default if not specified)
Work telephone number
Mobile Mobile telephone number
Examples
Sending a new individual:
<PersonInfo>
<SIN>987654321</SIN>
<Name>
<LastName>Smith</LastName>
<FirstName>Kathleen</FirstName>
<MiddleName>Anne</MiddleName>
<StartDate>1968-11-04</StartDate>
</Name>
<Email Type="Primary">[email protected]</Email>
<Email Type="Alternate">[email protected]</Email>
<Demographics>
<Gender>F</Gender>
</Demographics>
<PersonAddress>
<Address Type="Mailing">
<Street>
<StreetNumber>1234</StreetNumber>
<StreetName>Main</StreetName>
<StreetType>St.</StreetType>
</Street>
<City>Ituna</City>
<StatePr Code="SK"/>
<Country Code="CA"/>
<PostalCode>S0K 2P0</PostalCode>
</Address>
</PersonAddress>
<PhoneNumber Format="NA" Type="Home">(306) 123-4567</PhoneNumber>
</PersonInfo>
Sending updates to an existing individual (update e-mail address and mailing address):
<PersonInfo>
<Email Type="Primary">[email protected]</Email>
<PersonAddress>
<Address Type="Mailing" StartDate=”2012-09-23”>
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 18 of 69
<Street>
<Line1>Box 1234</Line1>
</Street>
<City>Biggar</City>
<StatePr Code="SK"/>
<Country Code="CA"/>
<PostalCode>S0K 2P0</PostalCode>
</Address>
</PersonAddress>
</PersonInfo>
Note that the new permanent mailing address is submitted with its effective date. This
will also be used to end date the previous permanent mailing address for this individual.
2.3 EmploymentInfo
This element is used to add or update an individual’s employment information.
Element Attribute Status Description/Notes
EmploymentInfo Information about an individual’s
employment organization.
Employer
Type
Required Type of employer (see below).
ContractIdentifier Required A unique identifier describing an
individual’s contract or
employment position for a school
year. May be reused subsequent
school years, but not in the
current school year. Used to
relate EmploymentInfo elements
to WorkAssignmentInfo
elements. Suggested format is
<Numeric ID><Contract #>, e.g.
“4704640_Contract_1” and
“4704640_Contract_2”.
ContractType Required Employment contract type.
Code Required ContractType Code (see below).
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 19 of 69
PercentTimeEmployed Required The percentage of time employed
by this employer. Expressed as
an integer in the range 1-100; e.g.
half-time would be expressed as
50, full time would be expressed
as 100.
StartDate Required The date when employment
started (date should fall in current
school year for K12 educators,
actual work start date for other
employees).
EndDate Optional The date when employment
ended / separation occurred (date
should fall in current school year
for K12 educators, actual work
end date for other employees).
SeparationReason Optional Reason for separation (K12
educators only).
Code Required Separation Reason code (see
below).
ExpectedActivity Optional Expected Activity following
Separation.
Code Required Expected Activity code (K12
educators only).
Affiliation Required The employee’s labour affiliation
Code Required Affiliation Type code (see
below). Professional association
or labour agreement.
EmploymentPosition Required Individual’s employment
position.
Code Required EmploymentPosition code (see
below).
EmploymentPosition /
PositionSubtype
Optional Details about the Coordinator /
Consultant employment position.
Code Required PositionSubtype code (see
below).
K12Employment Optional Information about an individual’s
K12 employment situation.
K12Employment /
Classification
Required Educator’s employment
classification.
Code Required Classification Code (see below).
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 20 of 69
K12Employment /
Step
Optional Educator’s employment Step.
This should be provided when
employment classification is not
“Out of Scope” or “Not
Applicable”.
Code Required Step Code (see below).
K12Employment /
Salary
Optional Employment salary. This should
be provided if the educator’s
professional association
affiliation is “LEADS” or
“None”.
K12Employment /
PrincipalVPAllowance
Optional Principal / VP allowance.
K12Employment /
AssessmentCoordinator
Required Is the individual an assessment
coordinator?
Code Required AssessmentCoordinator Code
(see below).
PreKEmployment Optional Information about an individual’s
PreK employment situation.
PreKEmployment /
Specialization
Required PreK employment specialization.
Code Required Specialization Code (see below).
PreKEmployment /
ProgramType
Required PreK employment program type.
Code Required ProgramType Code (see below).
PreKEmployment /
ProfDevEvents
Optional
and
Repeatable
Professional development events
attended (free form text).
PreKEmployment /
SponsoredEvents
Optional
and
Repeatable
Ministry sponsored events
attended (free form text).
PreKEmployment /
BBOrgMember
Required Individual is a member of a
BlackBoard organization?
Code Required BBOrgMember Code (see below)
PreKEmployment /
Assignment
Optional Individual is assigned to Program
or Student?
Code Required Assignment Code (see below)
PreKEmployment /
Education
Optional Individual’s highest level of
education.
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 21 of 69
Code Required Education Code (see below).
Employer Type Values (Certified K12 Educators)
01 School Division
02 School
03 Aboriginal Head Start
04 First Nations Band
05 Tribal Council
06 Regional College
Separation Code Values (Certified K12 Educators)
01 Death
02 Deferred Salary Leave
03 Educational Leave
04 Illness / Disability
05 Leave of Absence with Pay
06 Leave of Absence without Pay
07 Parenting Leave
08 Professional Misconduct
09 Resigned
10 Superannuated
11 Suspended by School Division
12 Teacher Exchange
13 Temporary Contract Expired
14 Terminated by School Division
ExpectedActivity Code Values (Certified K12 Educators)
01 Attend Post Secondary Institution
02 Employment in a field not related to Education
03 Employment in a field related to Education
04 Employment in a Private / Independent School
05 Employment with another School Division
06 Employment with Band / Federal School System
07 Illness / Disability
08 Not seeking employment
09 Parenting
10 Self-Employment
11 Travel / Leisure
12 Unemployed
13 Unknown
14 Other
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 22 of 69
Affiliation Code Values (Certified K12 Educators)
01 None
02 STF
03 LEADS
04 CUPE
05 SGEU
EmploymentPosition Code Values (Certified K12 Educators and Non-Certified Educators)
01 Teacher (K12, includes itinerants)
02 Teacher on Assignment (K12, based at the board office)
03 Principal (K12)
04 Assistant Principal (K12)
05 Vice Principal (K12)
06 Director of Education (K12)
07 Assistant Director of Education (K12)
08 Superintendent (K12)
09 Assistant Superintendent (K12)
10 Counsellor (K12)
11 Speech Language Pathologist (K12)
12 Psychologist (K12)
13 Coordinator (K12, see position subtypes below)
14 Consultant (K12, see position subtypes below)
15 Seconded (K12)
16 Other LEADS position (K12)
17 Chairperson
18 Data Entry Clerk
19 Outreach Worker
20 Chief Financial Officer
21 Assistant Chief Financial Officer
22 Manager (administration)
23 Supervisor (administration)
24 IT Support Person
25 Building Security Officer
26 Stock Worker
27 Librarian & Resource Centre Technician
28 Education Assistant / Teacher Associate
29 Caretaker / Janitor
30 Maintenance and Repair Person
31 Teacherage Person
32 Bus Driver (non contracted)
33 Bus Supervisor
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 23 of 69
34 Clerical / Stores Person
35 Mechanic
36 Building & Grounds Supervisor
37 Assistant / Clerk
38 Administrative Assistant at School
39 Administrative Assistant at School Division
40 Facilitator
41 Coordinator (administration, see position subtypes below)
42 Consultant (administration, see position subtypes below)
43 Officer (administration)
44 Superintendent (administration)
45 Medical Facilitator
46 Elder
47 Community School Coordinator (instructional)
48 Occupational Therapist (instructional)
49 Physical Therapist (instructional)
50 Speech Language Pathologist (instructional)
51 Counsellor (instructional, see position subtypes below)
52 Cafeteria Worker
53 Teacher (PreK)
54 Associate (PreK)
PositionSubtype Code Values (Certified K12 Educators)
01 Addictions (Deprecated – no longer collected)
02 Career (Deprecated – no longer collected)
03 Guidance (Deprecated – no longer collected)
04 Curriculum
05 Information Technology
06 Student Support Services
07 Other
Classification Code Values (Certified K12 Educators)
01 Class 1
02 Class 2
03 Class 3
04 Class 4
05 Class 5
06 Class 6
07 Class C
08 Out of Scope
09 Not Applicable
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 24 of 69
Step Code Values (Certified K12 Educators)
01 Step 1
02 Step 2
03 Step 3
04 Step 4
05 Step 5
06 Step 6
07 Step 7
08 Step 8
09 Step 9
10 Step 10
11 Step 11
ContractType Code Values (Certified K12 Educators)
01 Regular
02 Temporary
03 Replacement
04 Other
05 Not Applicable
AssessmentCoordinator Code Values (Certified K12 Educators)
Yes Individual is an assessment coordinator
No Individual is not an assessment coordinator
Assessment Coordinator - That individual who is responsible for the
administration, analysis and reporting of division, provincial, national and
international assessments.
Specialization Code Values
01 None
02 ECE (Early Childhood Educator)
ProgramType Code Values
01 AM
02 PM
03 Full Day
BBOrgMember Code Values
Yes Individual is a member of a BlackBoard organization.
No Individual is not a member of a BlackBoard organization.
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 25 of 69
Assignment Code Values
01 Individual is assigned to a student.
02 Individual is assigned to a program.
Education Code Values
01 Individual has a bachelor degree.
02 Individual has a master’s degree.
03 Individual has a doctorate degree.
Example
Sending a K12 educator’s employment information:
<EmploymentInfo Type=”01”>
<ContractIdentifier>Smith_Contract_1</ContractIdentifier>
<PercentTimeEmployed>100</PercentTimeEmployed>
<StartDate>2013-04-31</StartDate>
<Affiliation Code=”02”/>
<EmploymentPosition Code =”01”/>
<K12Employment>
<Classification Code = “04”/>
<Step Code = “05”/>
<ContractType Code = “01”/>
<Salary>67000</Salary>
<AssessmentCoordinator Code = “No”/>
</K12Employment>
</EmploymentInfo>
2.4 WorkAssignmentInfo
This element is used to add or update an individual’s work assignment information.
Element Attribute Status Description/Notes
WorkAssignmentInfo Information about an
individual’s work assignment
at an organization.
WorkSiteIdentifier Required Unique identifier of the
employee’s work site, e.g.
school’s department assigned
number.
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 26 of 69
ContractIdentifier Required A unique identifier describing
an individual’s contract or
employment position for a
school year. May be reused
subsequent school years, but
not in the current school year.
Used to relate
EmploymentInfo elements to
WorkAssignmentInfo
elements. Suggested format
is <Numeric ID><Contract
#>, e.g.
“4704640_Contract_1” and
“4704640_Contract_2”.
PercentTimeWorked Required The percentage of time spent
at this work site. Expressed
as an integer in the range 1-
100; e.g. half-time would be
expressed as 50, full time
would be expressed as 100.
StartDate Required The date when the work
assignment began (date
should fall in current school
year for K12 educators, actual
work assignment start date for
other employees).
EndDate Optional The date when the work
assignment ended (date
should fall in current school
year for K12 educators, actual
work assignment end date for
other employees).
K12WorkAssignment Optional Information about an
individual’s K12 work
assignment.
K12WorkAssignment /
K12TeacherTime
Optional
and
Repeatable
K12 Teacher time allocation
expressed as an integer (1-
100).
Code Required K12TeacherTime code (see
below).
K12WorkAssignment /
K12Supervisory
Optional
and
Repeatable
K12 Supervisory headcounts
expressed as a real number.
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 27 of 69
Code Required K12Supervisory code (see
below).
SASWorkAssignment Optional Information about an
individual’s Student
Achievement and Supports
work assignment
SASWorkAssignment /
StudentSupportTime
Optional
and
Repeatable
Student Support time
allocation expressed as an
integer (1-100).
Code Required StudentSupportTime code
(see below).
AdminWorkAssignment Optional Information about an
individual’s Administration
work assignment.
AdminWorkAssignment /
AdminTime
Optional
and
Repeatable
Administration time
allocation expressed as an
integer (1-100).
Code Required AdminTime code (see
below).
PlantOpsWorkAssignment Optional Information about an
individual’s Plant Operations
work assignment.
PlantOpsWorkAssignment /
PlantOpsTime
Optional
and
Repeatable
Plant Operations time
allocation expressed as an
integer (1-100).
Code Required PlantOpsTime code (see
below).
TransAdminWorkAssignment Optional Information about an
individual’s Transportation
Administration work
assignment.
TransAdminWorkAssignment /
TransAdminTime
Optional
and
Repeatable
Transportation
Administration time
allocation expressed as an
integer (1-100).
Code Required TransAdminTime code (see
below).
GovernanceWorkAssignment Optional Information about an
individual’s Governance
work assignment.
GovernanceWorkAssignment /
GovernanceTime
Optional
and
Repeatable
Governance time allocation
expressed as an integer (1-
100).
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 28 of 69
Code Required GovernanceTime code (see
below).
ExternalServiceWorkAssignment Optional Information about an
individual’s External Service
work assignment.
ExternalServiceWorkAssignment /
ExternalServiceTime
Optional
and
Repeatable
External Service time
allocation expressed as an
integer (1-100).
Code Required ExternalServiceTime code
(see below).
LibraryWorkAssignment Optional Information about an
individual’s Library and
Resource Centre work
assignment.
LibraryWorkAssignment /
LibraryTime
Optional
and
Repeatable
Librarian & Resource Centre
time allocation expressed as
an integer (1-100).
Code Required LibraryTime code (see
below).
PreKWorkAssignment Optional Information about an
individual’s pre-Kindergarten
work assignment.
PreKWorkAssignment /
PreKTime
Optional
and
Repeatable
PreK Teacher time allocation
expressed as an integer (1-
100).
Code Required PreKTime code (see below).
K12TeacherTime Code Values (Certified K12 Educators)
01 Teacher Time
02 In-School Prep Time
03 Student Support Services Time (includes teachers with assignments of
Learning Assistance, Learning Resource, Special Education, Diversity,
Response to Intervention, etc.)
04 In-School Admin Time
05 EAL Teacher Time (includes teachers with group teaching assignments
consisting of English as an Additional Language students (only) OR
providing support to EAL student(s) in another teacher’s classroom)
06 Counselling Time (includes career counseling, guidance counselling,
personal counselling, in-school counselling, etc.)
07 Teacher Librarian Time
08 Other Time
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 29 of 69
K12Supervisory Code Values (Certified K12 Educators)
01 Educator Full Time Headcount (include teachers and vice or assistant
principals who work 100% at a school)
02 Educator Part Time Headcount (include teachers and vice or assistant
principals who work <100% at a school)
03 Educator FTE ((if educator headcounts are provided, total must be
greater than or equal to full time headcount)).
04 # of Pending Certificates Headcount
05 VP Full Time Headcount (identify number of vice principals who work
100% at a school; this provides a detailed breakdown of the Educator
Full Time Headcount)
06 VP Part Time Headcount (identify number of vice principals who work
<100% at a school; this provides a detailed breakdown of the Educator
Full Time Headcount)
07 AP Full Time Headcount (identify number of assistant principals who
work 100% at a school; this provides a detailed breakdown of the
Educator Full Time Headcount)
08 AP Part Time Headcount (identify number of assistant principals who
work <100% at a school; this provides a detailed breakdown from the
Educator Full Time Headcount)
09 Admin FTE (if vice and assistant principal headcounts are provided, total
must be greater than or equal to VP or AP Full Time Headcount)
10 Non-Teaching Headcount (headcount of nurses, administrative
individuals, etc., BUT NOT caretaker / janitorial staff, maintenance
personnel or bus drivers)
StudentSupportTime Code Values (Non-certified Employees)
01 Career Counseling Time
02 Personal Counseling Time
03 Addictions Counseling Time
04 Social Work Time
05 Speech Pathologist Time
06 Nutritionist Time
07 Psychologist Time
08 Physical Therapist Time
09 Occupational Therapist Time
10 Community School Time
11 Outreach Worker Time
12 Other Medical Facilitator Time
13 Elder Time
14
Education Assistant Time
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 30 of 69
AdminTime Code Values (Non-certified Employees)
01 CFO Time
02 Assistant CFO Time
03 Superintendent Time
04 Manager Time
05 Manager Requiring VAP (visual/acoustic privacy) Time
06 Supervisor Time
07 Officer Time
08 Consultant Time
09 Coordinator Time
10 Facilitator Time
11 Admin Assistant (SD office) Time
12 Admin Assistant (school) Time
13 Clerk Time
14 IT Support Time
15 Building Security Officer Time
16 Data Entry Clerk Time
17 Stock Worker Time
PlantOpsTime Code Values (Non-certified Employees)
01 Caretaking / Janitorial Time
02 Maintenance / Repair Time
03 Building and Grounds Supervisor Time
04 Clerical / Stores Time
05 Teacherages Personnel Time
TransAdminTime Code Values (Non-certified Employees)
01 Bus Driver Time
02 Bus Supervisor Time
03 Clerical / Stores Time
04 Mechanic Time
GovernanceTime Code Values (Non-certified Employees)
01 Chairperson Time
ExternalServiceTime Code Values (Non-certified Employees)
01 Cafeteria Time
LibraryTime Code Values (Non-certified Employees)
01 Librarian & Resource Centre Time
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 31 of 69
PreKTime Code Values (Non-certified Employees)
01 PreK Educator Time
02 PreK Associate Time
Examples
Sending a K12 educator’s work assignment information:
<WorkAssignmentInfo>
<WorkSiteIdentifier>9190004</WorkSiteIdentifier>
<ContractIdentifer>4704640_Contract_1</ContractIdentifier>
<PercentTimeWorked>100</PercentTimeWorked>
<StartDate>2015-01-01</StartDate>
<K12WorkAssignment>
<K12TeacherTime Code=”01”>90</K12TeacherTime>
<K12TeacherTime Code=”02”>10</K12TeacherTime>
</K12WorkAssignment>
</WorkAssignmentInfo>
Sending a PreK educator’s work assignment information:
<WorkAssignmentInfo>
<WorkSiteIdentifier>1234567</WorkSiteIdentifer>
<ContractIdentifer>1234567_2014_Contract</ContractIdentifier>
<PercentTimeWorked>100</PercentTimeWorked>
<StartDate>2015-01-01</StartDate>
<PreKWorkAssignment>
<PreKTime Code=”01”>100</PreKTime>
</PreKWorkAssignment>
</WorkAssignmentInfo>
Sending a principal’s work assignment information:
<WorkAssignmentInfo>
<WorkSiteIdentifier>9190004</WorkSiteIdentifer>
<ContractIdentifer>4704640_Contract_1</ContractIdentifier>
<PercentTimeWorked>100</PercentTimeWorked>
<StartDate>2015-01-01</StartDate>
<K12WorkAssignment>
<K12TeacherTime Code=”01”>90</K12TeacherTime>
<K12TeacherTime Code=”04”>10</K12TeacherTime>
<K12Supervisory Code =”03”>5.7</K12Supervisory> <K12Supervisory Code =”09”>1</K12Supervisory>
<K12Supervisory Code =”10”>4</K12Supervisory>
</K12WorkAssignment> `
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 32 of 69
</WorkAssignmentInfo>
2.5 ClassroomInfo
This element is used to add or update an educator’s classroom information.
Element Attribute Status Description/Notes
ClassroomInfo Information about an educator’s
classroom at school.
SchoolDAN Required School department assigned
number. School DAN must be
the same as the employer DAN,
or report to the employer DAN
(e.g. school division).
ClassroomIdentifier Optional Unique identifier of the
educator’s classroom. Free-
form text, e.g.
‘TSmithMath5AM’. Identifier
is system-generated if not
provided.
MultiGrade Required Multi-grade classroom indicator.
Code Required Multi-grade code (see below).
StartDate Required The date when the class began
(date should fall in current
school year).
EndDate Optional The date when the class ended
(date should fall in current
school year). Defaults to July 31
of the current school year if not
provided.
Composition Required
and
Repeatable
Information about the class
composition (subject code,
student count). Repeatable for
multigrade classroom settings.
Composition /
Subject
Required Subject information.
Code Required Subject code (see Appendix A).
Composition /
StudentCount
Required Number of students in the
subject offering.
MultiGrade Code Values
Yes Classroom is multi-grade.
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 33 of 69
No Classroom is not multi-grade.
Example
Sending a K12 educator’s classroom information (multigrade):
<ClassroomInfo>
<SchoolDAN>1234567</SchoolDAN>
<ClassroomIdentifier>Thomas5A</ClassroomIdentifier>
<Multigrade Code = “Yes”/>
<StartDate>2014-08-01</StartDate>
<Composition>
<Subject Code=”500”/>
<StudentCount>10</StudentCount>
</Composition>
<Composition>
<Subject Code=”600”/>
<StudentCount>15</StudentCount>
</Composition>
</ClassroomInfo>
Sending a K12 educator’s classroom information (non-multigrade):
<ClassroomInfo>
<SchoolDAN>1234567</SchoolDAN>
<ClassroomIdentifier>Thomas6</ClassroomIdentifier>
<Multigrade Code = “No”/>
<StartDate>2014-08-01</StartDate>
<EndDate>2014-12-21</EndDate>
<Composition>
<Subject Code=”600”/>
<StudentCount>11</StudentCount>
</Composition>
</ClassroomInfo>
2.6 CertificateInfo
This element is used to add or update an educator’s professional certification information
-- for use only by the Saskatchewan Professional Teachers Regulatory Board (SPTRB);
not to be submitted by school divisions.
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 34 of 69
Element Attribute Status Description/Notes
CertificateInfo Information about an educator’s
professional certification.
Type Required Status of certificate.
CertificateType Required Type of certificate.
Code Required CertificateType code (see
below).
Provisional Required Certificate provisional status.
Code Required Provisional code (see below).
Condition Required Certificate condition.
Code Required Condition code (see below).
SuspensionReason Optional Reason for certificate
suspension. Must be provided
when certificate status = ‘02’
(suspended).
Code Required SuspensionCancellation code
(see below).
CancellationReason Optional Reason for certificate
cancellation. Must be provided
when certificate status = ‘03’
(cancelled).
Code Required SuspensionCancellation code
(see below).
IssueDate Optional Certificate issue date.
Mandatory for an active
certificate (i.e. certificate status
= ‘01’).
StartDate Required The start date of the active
certificate, certificate
suspension, or certificate
cancellation.
EndDate Optional The end date of the active
certificate, certificate
suspension, or certificate
cancellation.
EndorsedSubject Optional
and
Repeatable
Subject(s) the educator is
endorsed to teach. Required for
provisional certificates.
Code Required EndorsedSubject code (see
below).
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 35 of 69
CertificateInfo Type Values
01 Active certificate
02 Suspended certificate
03 Cancelled certificate
CertificateType Code Values
01 Professional A
02 Professional B
03 Technical
04 Vocational
05 Standard A
06 Standard B
07 Probationary
08 Probationary B
09 Letter of Eligibility
10 Additional Qualification Certificate
11 Other
12 Unknown
13 Temporary Teaching Permit
Provisional Code Values
Yes Certificate is provisional
No Certificate is not provisional
Condition Code Values
01 N/A
02 Certification Agreement
03 Regular Condition
04 Other
SuspensionCancellation Code Values
01 N/A
02 Unprofessional Conduct
03 Incompetent
04 Surrendered by Teacher
05 Cancelled / Suspended in other Province / State
06 Other
EndorsedSubject Code Values
01 Art
02 Business Education
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 36 of 69
03 Computer Science
04 Guidance and Counselling
05 Home Economics
06 Industrial Arts
07 Music
08 Physical Education
09 Religion
10 Special Education
11 Speech Pathology
12 Technical Vocational Education
13 Drafting
14 Electricity
15 Electronics
16 Motor Mechanics
17 Cosmetology
18 Carpentry
19 Food Services
20 Machinist
21 Millwright
22 Motor Vehicle Repair
23 Plumbing and Heating
24 Welding
25 Special Education / Guidance
26 Cook
27 Beauty Culture
28 Horticulture
29 Architecture
30 Educational Psychology
31 Automotive Service Technician
32 Agricultural Machinery Technician
33 Heavy Duty Mechanic
34 Classics – History
35 Classics – Language Arts
36 Early Childhood Education
37 Motor Vehicle Mechanics
38 Practical and Applied Arts
39 Sheet Metal
40 Teaching French as a Second Language
41 Teaching English as a Second Language
42 Hairstylist
43 Communications Media
44 Drafting and Computer Aided Design
45 Adult Education
46 Housing
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 37 of 69
47 Construction and Carpentry
Example
Sending a K12 educator’s professional certification information:
<EducatorCertification RefId="1">
<PersonIdentification>
<PersonId Type="01">7654321</PersonId>
<BirthDate>1982-09-17</BirthDate>
</PersonIdentification>
<CertificateInfo Type=”01”>
<CertificateType Code="02"/>
<Provisional Code="Yes"/>
<Condition Code="01"/>
<IssueDate>2015-11-19</IssueDate>
<StartDate>2015-11-19</StartDate>
<EndDate>2016-11-19</EndDate>
<EndorsedSubject Code="01"/>
<EndorsedSubject Code="02"/>
</CertificateInfo>
<CertificateInfo Type=”01”>
<CertificateType Code="01"/>
<Provisional Code="No"/>
<Condition Code="01"/>
<IssueDate>2016-11-02</IssueDate>
<StartDate>2016-11-02</StartDate>
</CertificateInfo>
</EducatorCertification>
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 38 of 69
3. Queries
Query allows an employer to request certain employee data from the Ministry of
Education. There are a limited number of pre-defined queries that are supported.
3.1 QueryByEmployee
This allows an employer to request information about one employee.
Element Attribute Status Description/Notes
QueryByEmployee A request to return information for a
specific employee.
RefId Required The reference ID for returning the
response.
ObjectName Required The name of the type of object to be
returned (see below)
PersonId Required Individual’s 7 digit educator
certificate number, 9 digit
Saskatchewan Learning ID, or null
string if Name element is provided
(below).
Type Required PersonId type (see below).
Name Optional Employee’s name(s). Either the
PersonId or the Name must be
included.
Name/LastName Required Last name.
Name/FirstName Required First name.
BirthDate Required The birth date of the employee whose
data is to be returned (a double-check
that the correct employee is being
queried)
Object Names Supported for QueryByEmployee
PersonInfo
Returns all personal (demographic) information recorded for the employee.
EmploymentInfo
Returns all employment information recorded for the employee.
WorkAssignmentInfo
Returns all work assignment information recorded for the employee.
ClassroomInfo
Returns all classroom information recorded for the teacher.
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 39 of 69
PersonID Type Values
01 Educator Certificate Number (certified educators)
02
Saskatchewan Learning ID (all non-certified educator staff)
Examples
Request work assignment information for an employee using Educator Certificate
Number:
<EAD_Query>
<QueryByEmployee RefId=”1” ObjectName=”WorkAssignmentInfo”>
< PersonId Type=”01”>1111111</PersonId >
<BirthDate>1989-01-05</BirthDate>
</QueryByEmployee>
</EAD_Query>
Request personal information for an employee using Saskatchewan Learning ID:
<EAD_Query>
<QueryByEmployee RefId=”2” ObjectName=”PersonInfo”>
<PersonId Type=”02”>123456789</PersonId >
<BirthDate>1997-03-15</BirthDate>
</QueryByEmployee>
</EAD_Query>
Request personal information for an employee using Name:
<EAD_Query>
<QueryByEmployee RefId=”3” ObjectName=”PersonInfo”>
<PersonId Type=”01”></PersonId >
<BirthDate>1968-11-04</BirthDate>
<Name>
<LastName>Smith</LastName>
<FirstName>John</FirstName>
</Name>
</QueryByEmployee>
</EAD_Query>
3.2 QueryByEmployer
This allows an employer to request information about their employees.
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 40 of 69
Element Attribute Status Description/Notes
QueryByEmployer A request to return information for
individuals employed by a specific
employer.
RefId Required The reference ID for returning the
response.
ObjectName Required The name of the type of object to be
returned (see below).
EmployerId Required The department-assigned number of
the employer for which the data is to
be returned.
FromDate Optional The start date of the date range for
which data is to be returned (current
school year). For PersonInfo and
EmploymentInfo query objects, this
applies to the work start date. For
WorkAssignmentInfo query object,
this applies to assignment start date.
For ClassroomInfo query object, this
applies to the session start date.
ToDate Optional The end date of the date range for
which data is to be returned (current
school year). For PersonInfo and
EmploymentInfo query objects, this
applies to the work end date. For
WorkAssignmentInfo query object,
this applies to assignment end date.
For ClassroomInfo query object, this
applies to the session end date.
Object Names Supported for Query
PersonInfo
Returns all personal (demographic) information recorded for employees.
EmploymentInfo
Returns all employment information recorded for employees.
WorkAssignmentInfo
Returns all work assignment information recorded for employees.
ClassroomInfo
Returns all classroom information recorded for teachers.
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 41 of 69
Example
Request all employment information for an organization during a particular date range
(in this case a school year):
<EAD_Query>
<QueryByEmployer RefId=”1” ObjectName=”EmploymentInfo”
<EmployerId>1234567</EmployerId>
<FromDate>2012-08-01</FromDate>
<ToDate>2013-07-31</ToDate>
</QueryByEmployer>
</EAD_Query>
3.3 QueryBySchool
This allows school-specific information to be queried. This query is similar to
QueryByEmployer, except a particular school can be specified, i.e. a subset of what
would be obtained with the QueryByEmployer / EmploymentInfo query.
Element Attribute Status Description/Notes
QueryBySchool A request to return information for
individuals working at a specific
school.
RefId Required The reference ID for returning the
response.
ObjectName Required The name of the type of object to be
returned (see below).
SchoolId Required The department-assigned number of
the school for which the data is to be
returned.
FromDate Optional The start date of the date range for
which data is to be returned (current
school year). For PersonInfo and
EmploymentInfo query objects, this
applies to the work start date. For
WorkAssignmentInfo query object,
this applies to assignment start date.
For ClassroomInfo query object, this
applies to the session start date.
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 42 of 69
ToDate Optional The end date of the date range for
which data is to be returned (current
school year). For PersonInfo and
EmploymentInfo query objects, this
applies to the work end date. For
WorkAssignmentInfo query object,
this applies to assignment end date.
For ClassroomInfo query object, this
applies to the session end date.
Object Names Supported for Query
PersonInfo
Returns all personal (demographic) information recorded for employees.
EmploymentInfo
Returns all employment information recorded for employees.
WorkAssignmentInfo
Returns all work assignment information recorded for employees.
ClassroomInfo
Returns all classroom information recorded for teachers.
Example
Request all classroom information for a school during a particular date range (in this
case a school year):
<EAD_Query>
<QueryBySchool RefId=”1” ObjectName=”ClassroomInfo”
<SchoolId>1234567</SchoolId>
<FromDate>2013-08-01</FromDate>
<ToDate>2014-07-31</ToDate>
</QueryBySchool>
</EAD_Query>
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 43 of 69
4. Message Infrastructure
Information is packaged into messages, such that one message contains one or more
objects, queries or responses.
Each message is “wrapped” in tags that define the message. The outermost tag of all
messages is EAD_Message. Within this tag is another tag identifying the type of
message:
EAD_Event
EAD_Request
EAD_Response
EAD_Ping
4.1 EAD_Message
The outermost tag on all messages.
Element Attribute Status Description/Notes
EAD_Message
xmlns Required The XML namespace that defines the
specifications for this major release (see
below)
xmlns:xsi Required The XML schema instance (see below)
xsi:schemaLocation Required The physical location of the XML
schema (see below)
Version Optional The version number of the XML
specifications (currently 1.0). Defaults to
1.0 if not specified.
XML Namespace and Related Values
For this release of the Ministry of Education’s Employment and Additional Data XML
specifications, use:
xmlns=”http://www.k12.gov.sk.ca/xsd/sl/1.x/EADMessage.xsd”
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.k12.gov.sk.ca/xsd/sl/1.x/EADMessage.xsd
http://www.k12.gov.sk.ca/xsd/sl/1.x/EADMessage.xsd"
Example
<EAD_Message xmlns=”http://www.k12.gov.sk.ca/xsd/sl/1.x/EADMessage.xsd”
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.k12.gov.sk.ca/xsd/sl/2.x/EADMessage.xsd
http://www.k12.gov.sk.ca/xsd/sl/1.x/EADMessage.xsd">
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 44 of 69
Message content goes here
</EAD_Message>
4.2 EAD_Header
Within each type of message is EAD_Header, which identifies the message and when it
was sent.
Element Attribute Status Description/Notes
EAD_Header
EAD_MsgId Required A unique identifier of the message (see note below)
EAD_Date Required The date the message was sent
EAD_Time Required The time at which the message was sent, in format
HH:MM:SS, using a 24-hour clock
Zone Optional The time zone, expressed as an offset from the zero
meridian (e.g., UTC-06:00 for Central Standard
Time). Defaults to “UTC-06:00” if not specified.
EAD_SourceId Required The unique ID of the originator of the message. This
is the department-assigned number of the
organization.
Note
EAD_MsgId has to be unique on every message sent between employers and the
Ministry of Education. The Ministry of Education cannot accept two XML messages
with the same EAD_MsgId, even if they come from different schools. EAD_MsgId can
be any length, as long as it is unique.
Two techniques to ensure uniqueness are recommended. Employers can choose from
either of these techniques:
Concatenate department-assigned employer number, date/time, message sequence
number and user ID to create a unique EAD_MsgId, where message sequence
number is used to distinguish two or more messages created by the same user in the
same second. Separate the parts of the message id by periods.
Format: {Employer Number}.{Date}.{Time}.{Message Sequence #}.{UserId}
Example: 1234567.20040115.200856.0001.doej
Use a Global Unique Identifier (GUID), also known as a Universal Unique Identifier
(UUID). This is a system-generated string of characters that is guaranteed to be
universally unique. Most technical platforms have a function that will generate
GUIDs, which can be accessed from development languages available on the
platform. Check your platform / development language documentation for how to
access this function.
Example: In Oracle SQL, a GUID can be generated as follows:
select sys_guid() from dual
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 45 of 69
Note: If a transmission problem prevented the Ministry of Education from receiving an
entire XML message and the message is being sent again, the EAD_MsgId can be kept
the same. Otherwise (e.g. if there is a problem with the XML that needs to be corrected,
such as a missing tag), a new EAD_MsgId should be used for the corrected message.
Example
<EAD_Header>
<EAD_MsgId>12345678901234567890123456789012</EAD_MsgId>
<EAD_Date>2012-09-23</EAD_Date>
<EAD_Time Zone="UTC-06:00">20:23:54</EAD_Time>
<EAD_SourceId>8888888</EAD_SourceId>
</EAD_Header>
4.3 EAD_Event
An event message indicates that data is to be added or changed.
Element Attribute Status Description/Notes
EAD_Event
EAD_Header Required See EAD_Header above
EAD_ObjectData Required Wrapper for the data being sent
EAD_ObjectData/
EAD_EventObject
Required
and
Repeatable
Identifies the type of object being sent
and wraps the data
ObjectName Required The name of the object being sent
Action Required The action this event conveys (see
below)
EAD_ObjectData/
EAD_EventObject/
objectname
Required
and
Repeatable
The actual data being sent (see object
specifications above)
Event Action Values
Add
Change
Delete
4.4 EAD_Request
A request message asks for data to be returned.
Element Attribute Status Description/Notes
EAD_Request
EAD_Header Required See EAD_Header above
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 46 of 69
EAD_Query Required The query for data. See EAD_Query
under Queries.
EAD_Query/
objectname
Required and
Repeatable
The actual queries, which can be any
query in Section 3.
Example
<EAD_Message xmlns=”http://www.k12.gov.sk.ca/xsd/sl/1.x/EADMessage.xsd”
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.k12.gov.sk.ca/xsd/sl/1.x/EADMessage.xsd
http://www.k12.gov.sk.ca/xsd/sl/1.x/EADMessage.xsd">
<EAD_Request>
<EAD_Header>
<EAD_MsgId>12345678901234567890123456789012</EAD_MsgId>
<EAD_Date>2012-09-16</EAD_Date>
<EAD_Time Zone="UTC-06:00">20:23:54</EAD_Time>
<EAD_SourceId>1234567</EAD_SourceId>
</EAD_Header>
<EAD_Query>
<QueryByEmployer RefId=”1” ObjectName=”EmploymentInfo”
<EmployerId>1234567</EmployerId>
<FromDate>2012-08-01</FromDate>
<ToDate>2013-07-31</ToDate>
</QueryByEmployer>
</EAD_Query>
</EAD_Request>
</EAD_Message>
4.5 EAD_Response
A response message acknowledges an event or request, indicates whether or not it could
be successfully processed, and sends data back if applicable.
Element Attribute Status Description/Notes
EAD_Response
EAD_Header Required See EAD_Header above
EAD_Ack Required Acknowledgement of the message
that elicited this response
EAD_Ack/
EAD_OriginalMsgId
Required The message ID of the message that
elicited this response
EAD_Ack/
EAD_OriginalSource Id
Required The unique ID of the originator of
the message that elicited this
response
EAD_Ack/EAD_Status Required Whether or not the original message
was successfully processed
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 47 of 69
EAD_Ack/EAD_Status/
EAD_StatusCode
Required Status code (see below)
EAD_Ack/EAD_Status/
EAD_StatusMsg
Optional Message if required to clarify the
status
EAD_Ack/EAD_Error Optional
and
Repeatable
Exception message
ObjectName Optional The name of the object that the error
relates to, if applicable
RefId Optional The reference ID of the object that
the error relates to, if applicable
EAD_Ack/EAD_Error/
EAD_ErrorSeverity
Required Message severity (see below)
EAD_Ack/EAD_Error/
EAD_ErrorCode
Required Error code (values published
separately)
EAD_Ack/EAD_Error/
EAD_ErrorMsg
Optional Message describing the error
EAD_ObjectData Optional Wrapper for any data being returned
EAD_ObjectData/
EAD_EventObject
Required
and
Repeatable
Identifies the type of object being
returned and wraps the data
ObjectName Required The name of the object being
returned
Action Required Will be set to “None”
Reason Optional Not applicable
EAD_ObjectData/
EAD_EventObject/
objectname
Required
and
Repeatable
The actual data being returned (see
object specifications above)
Status Code Values
Successful Processed successfully, no messages or only informational messages
Warnings Processed successfully with warning messages
Errors Processed with error messages
Invalid Invalid XML
Message Severity Values
Informational
Warning
Error
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 48 of 69
4.6 EAD_Ping
The ping message allows an organization to determine whether the Ministry of Education
XML gateway is receiving messages.
Element Attribute Status Description/Notes
EAD_Ping Required Request to acknowledge the ping
EAD_Header Required See EAD_Header above
Example
<EAD_Message xmlns=”http://www.k12.gov.sk.ca/xsd/sl/1.x/EADMessage.xsd”
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.k12.gov.sk.ca/xsd/sl/1.x/EADMessage.xsd
http://www.k12.gov.sk.ca/xsd/sl/1.x/EADMessage.xsd">
<EAD_Ping>
<EAD_Header>
<EAD_MsgId>12345678901234567890123456789012</EAD_MsgId>
<EAD_Date>2013-06-21</EAD_Date>
<EAD_Time Zone="UTC-06:00">20:23:54</EAD_Time>
<EAD_SourceId>1234567</EAD_SourceId>
</EAD_Header>
</EAD_Ping>
</EAD_Message>
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 49 of 69
Appendix A – Subject Codes
Subject Code Subject
08 Christian Ethics Kindergarten
10 Kindergarten
12 Maternelle (French Kindergarten)
15 Pre Kindergarten 4
17 PreMaternelle 4 (French Pre-Kindergarten)
18 English Language Arts Kindergarten
19 Mathematics Kindergarten
20 Science Kindergarten
21 Social Studies Kindergarten
22 Health Education Kindergarten
23 Arts Education Kindergarten
24 Physical Education Kindergarten
33 Sciences Humaines Kindergarten
35 Éducation physique Kindergarten
36 Sciences Kindergarten
39 Français Kindergarten
40 Mathématiques Kindergarten
43 Bienêtre Kindergarten
44 Programme d'études interdisciplinaire Kindergarten
100 English Language Arts 1
101 Mathematics 1
102 Science 1
103 Social Studies 1
104 Health Education 1
105 Arts Education 1
106 Physical Education 1
108 Christian Ethics 1
111 German 1
112 Core French 1
113 Ukrainian 1
114 Français 1
117 Dene 1
118 Cree 1
119 Ojibway 1
120 Mandarin 1
122 Éducation artistique 1
127 Orientation Des Carrieres 1
129 Mathématiques 1
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 50 of 69
131 Éducation physique 1
132 Sciences 1
133 Sciences Humaines 1
135 Éducation chrétienne 1
143 Bienêtre 1
144 Programme d'études interdisciplinaire 1
154 Saulteaux 1
162 Practical And Applied Arts 1
163 Arts pratiques et appliqués, cours combiné 1
164 cours choisi localement 1
165 Locally Determined Option 1
167 Français langue première 1
200 English Language Arts 2
201 Mathematics 2
202 Science 2
203 Social Studies 2
204 Health Education 2
205 Arts Education 2
206 Physical Education 2
208 Christian Ethics 2
211 German 2
212 Core French 2
213 Ukrainian 2
214 Français 2
217 Dene 2
218 Cree 2
219 Ojibway 2
220 Mandarin 2
222 Éducation artistique 2
227 Orientation Des Carrieres 2
229 Mathématiques 2
231 Éducation physique 2
232 Sciences 2
233 Sciences Humaines 2
235 Éducation chrétienne 2
243 Bienêtre 2
244 Programme d'études interdisciplinaire 2
254 Saulteaux 2
262 Practical And Applied Arts 2
263 Arts pratiques et appliqués, cours combiné 2
264 cours choisi localement 2
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 51 of 69
265 Locally Determined Option 2
267 Français langue première 2
300 English Language Arts 3
301 Mathematics 3
302 Science 3
303 Social Studies 3
304 Health Education 3
305 Arts Education 3
306 Physical Education 3
308 Christian Ethics 3
311 German 3
312 Core French 3
313 Ukrainian 3
314 Français 3
317 Dene 3
318 Cree 3
319 Ojibway 3
320 Mandarin 3
322 Éducation artistique 3
327 Orientation Des Carrieres 3
329 Mathématiques 3
331 Éducation physique 3
332 Sciences 3
333 Sciences Humaines 3
335 Éducation chrétienne 3
343 Bienêtre 3
354 Saulteaux 3
362 Practical And Applied Arts 3
363 Arts pratiques et appliqués, cours combiné 3
364 cours choisi localement 3
365 Locally Determined Option 3
367 Français langue première 3
400 English Language Arts 4
401 Mathematics 4
402 Science 4
403 Social Studies 4
404 Health Education 4
405 Arts Education 4
406 Physical Education 4
408 Christian Ethics 4
411 German 4
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 52 of 69
412 Core French 4
413 Ukrainian 4
414 Français 4
417 Dene 4
418 Cree 4
419 Ojibway 4
420 Mandarin 4
422 Éducation artistique 4
427 Orientation Des Carrieres 4
429 Mathématiques 4
431 Éducation physique 4
432 Sciences 4
433 Sciences Humaines 4
435 Éducation chrétienne 4
443 Bienêtre 4
454 Saulteaux 4
462 Practical And Applied Arts 4
463 Arts pratiques et appliqués, cours combiné 4
464 cours choisi localement 4
465 Locally Determined Option 4
467 Français langue première 4
500 English Language Arts 5
501 Mathematics 5
502 Science 5
503 Social Studies 5
504 Health Education 5
505 Arts Education 5
506 Physical Education 5
508 Christian Ethics 5
511 German 5
512 Core French 5
513 Ukrainian 5
514 Français 5
515 Band 5
517 Dene 5
518 Cree 5
519 Ojibway 5
520 Mandarin 5
522 Éducation artistique 5
527 Orientation Des Carrieres 5
529 Mathématiques 5
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 53 of 69
531 Éducation physique 5
532 Sciences 5
533 Sciences Humaines 5
535 Éducation chrétienne 5
543 Bienêtre 5
554 Saulteaux 5
562 Practical And Applied Arts 5
563 Arts pratiques et appliqués, cours combiné 5
564 cours choisi localement 5
565 Locally Determined Option 5
567 Français langue première 5
600 English Language Arts 6
601 Mathematics 6
602 Science 6
603 Social Studies 6
604 Health Education 6
605 Arts Education 6
606 Physical Education 6
608 Christian Ethics 6
611 German 6
612 Core French 6
613 Ukrainian 6
614 Français 6
615 Band 6
617 Dene 6
618 Cree 6
619 Ojibway 6
620 Mandarin 6
625 Practical And Applied Arts 6
626 Éducation artistique 6
631 Orientation Des Carrieres 6
633 Mathématiques 6
635 Éducation physique 6
636 Sciences 6
637 Sciences Humaines 6
639 Éducation chrétienne 6
641 Career Education 6
643 Bienêtre 6
654 Saulteaux 6
663 Arts pratiques et appliqués, cours combiné 6
664 cours choisi localement 6
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 54 of 69
665 Locally Determined Option 6
666 Sensibilisation aux carrieres 6
668 Intensive French 6
700 English Language Arts 7
701 Mathematics 7
702 Science 7
703 Social Studies 7
704 Health Education 7
705 Arts Education 7
706 Physical Education 7
708 Christian Ethics 7
711 German 7
712 Core French 7
713 Ukrainian 7
714 Français 7
715 Band 7
717 Dene 7
718 Cree 7
719 Ojibway 7
720 Mandarin 7
725 Practical And Applied Arts 7
726 Éducation artistique 7
731 Orientation Des Carrieres 7
733 Mathématiques 7
735 Éducation physique 7
736 Sciences 7
737 Sciences Humaines 7
739 Éducation chrétienne 7
741 Career Education 7
743 Bienêtre 7
754 Saulteaux 7
763 Arts pratiques et appliqués, cours combiné 7
764 cours choisi localement 7
765 Locally Determined Option 7
766 Sensibilisation aux carrieres 7
768 Post-Intensive French 7
800 English Language Arts 8
801 Mathematics 8
802 Science 8
803 Social Studies 8
804 Health Education 8
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 55 of 69
805 Arts Education 8
806 Physical Education 8
808 Christian Ethics 8
811 German 8
812 Core French 8
813 Ukrainian 8
814 Français 8
815 Band 8
817 Dene 8
818 Cree 8
819 Ojibway 8
820 Mandarin 8
825 Practical And Applied Arts 8
826 Éducation artistique 8
831 Orientation Des Carrieres 8
833 Mathématiques 8
835 Éducation physique 8
836 Sciences 8
837 Sciences Humaines 8
839 Éducation chrétienne 8
841 Career Education 8
843 Bienêtre 8
854 Saulteaux 8
863 Arts pratiques et appliqués, cours combiné 8
864 cours choisi localement 8
865 Locally Determined Option 8
866 Sensibilisation aux carrieres 8
868 Post-Intensive French 8
900 English Language Arts 9
901 Mathematics 9
902 Science 9
904 Practical And Applied Arts 9
906 Physical Education 9
908 Christian Ethics 9
911 Arts Education 9
913 Social Studies 9
914 Français 9
915 Band 9
920 Dene 9
921 Cree 9
922 Ojibway 9
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 56 of 69
923 Mandarin 9
925 Éducation physique 9
926 Éducation artistique 9
931 Orientation Des Carrieres 9
933 Mathématiques 9
935 German 9
936 Sciences 9
937 Sciences Humaines 9
941 Core French 9
943 Éducation chrétienne 9
944 Ukrainian 9
946 Career Education 9
950 Health Education 9
954 Saulteaux 9
960 Bienêtre 9
963 Arts pratiques et appliqués, cours combiné 9
964 cours choisi localement 9
965 Locally Determined Option 9
966 Sensibilisation aux carrieres 9
968 Post-Intensive French 9
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 57 of 69
Appendix B – Country Codes
Source: ISO-3166-1. The list does not have separate codes for all dialects within each
language. The following list has had some specific languages and codes added. It also
includes some languages without codes and indicates which associated language to use
instead.
ABK Abkhazian ACE Achinese ACH Acoli ADA Adangme ADY Adyghe AAR Afar AFH Afrihili (Artificial language) AFR Afrikaans AFA Afro-Asiatic Languages AIN Ainu AKA Akan AKK AQA
Akkadian Alacalufan Languages
ALB Albanian ALE AQL
Aleut languages Algic languages
ALG Algonquian languages AJM ALT
Aljamia Altai (Southern)
TUT Altaic Languages AMH Amharic ANP Angika APA Apache languages ARA Arabic ARG Aragonese ARC Aramaic (Official) ARP AUF
Arapaho Arauan languages
ARW AWD
Arawak Arawakan languages
ARM Armenian RUP Aromanian; Macedo-Romanian ART Artificial Languages ASM Assamese AST Asturian; Bable ATH ALV
Athapascan languages Atlantic-Congo Languages
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 58 of 69
AUS AAV
Australian languages Austro-Asiatic Language
MAP Austronesian Languages AVA Avaric AVE Avestan AWA Awadhi AYM Aymara AZE Azerbaijani BAN Balinese BAT Baltic Languages BAL Baluchi BAM Bambara BAI Bamileke languages BAD Banda languages BNT Bantu languages BAS Basa (Cameroon) BAK Bashkir BAQ Basque BTK Batak languages BEJ Beja BEL Belarusian BEM Bemba (Zambia) BEN Bengali BER Berber languages BHO Bhojpuri BIH Bihari Languages BIK BYN
Bikol Bilin
BIN Bini BIS Bislama BOS Bosnian BRA Braj BRE Breton BUG Buginese BUL Bulgarian BUA Buriat BUR Burmese BEL Byelorussian CAD Caddo CAT Catalan CAU CCN CCS
Caucasian languages Caucasian languages (North) Caucasian languages (South)
CEB Cebuano
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 59 of 69
CEL Celtic languages CAI Central American Indian languages KHM CSU CDC
Central Khmer Central Sudanic languages Chadic languages
CHG Chagatai CMC Chamic languages CHA Chamorro CHE Chechen CHR Cherokee CHY Cheyenne CHB CBA
Chibcha Chibchan languages
NYA Chichewa; Nyanja YUE Chinese, Cantonese CHI Chinese, Mandarin CHN Chinook jargon CHP Chipewyan CHO Choctaw CHU Church Slavic CHK Chuukese CHV Chuvash NWC Classical Newari SYR Classical Syriac COP Coptic COR Cornish COS Corsican CRE Cree MUS Creek CRP Creoles and Pidgins CPE Creoles and Pidgins, English-based CPF Creoles and Pidgins, French-based CPP Creoles and Pidgins, Portuguese-based CRH Crimean Tatar SCR HRV
Croatian (No Longer Available – see HRV) Croatian
CUS Cushitic Languages CZE Czech DAK Dakota DAN Danish DAR Dargwa DEL Delaware CHP DIV
Dene Suline Dhivehi; Maldivian
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 60 of 69
DIN Dinka DOI Dogri DGR Dogrib DRA Dravidian Language DUA Duala DUT Dutch DUM Dutch, Middle (ca. 1050-1350) DYU Dyula DZO Dzongkha EFI Efik EGY Egyptian EKA Ekajuk ELX Elamite ENG English ENM English, Middle (1100-1500) ANG English, Old (ca. 450-1100) MYV Erzya ESP Esperanto EST Estonian ETH Ethiopic EWE Ewe EWO Ewondo FAN Fang FAT Fanti FAR Faroese PER Farsi FIJ Fijian FIL Filipino; Pilipino FIN Finnish FIU Finno-Ugrian languages VLA Flemish FON Fon FRE French FRM French, Middle (ca. 1400-1600) FRO French, Old (ca. 842-1400) FRI Frisian FRS Frisian, Eastern FRR Frisian, Northern FRY Frisian. Western FUR Friulian FUL Fulah GAA Ga GAE Gaelic, Scots CAR Galibi Carib
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 61 of 69
GAG Galician LUG Ganda GAY Gayo GBA Gbaya GEZ Geez GEO Georgian GER German GMH German, Middle High (ca. 1050-1500) GOH German, Old High (ca. 750-1050) GEM Germanic Languages GIL Gilbertese GON Gondi GOR Gorontalo GOT Gothic GRB Grebo GRC Greek, Ancient (to 1453) GRE Greek, Modern (1453- ) GUA Guarani GUJ Gujarati GWI Gwich’in HAI Haida HAT Haitian HAU Hausa HAW Hawaiian HEB Hebrew HER Herero HIL Hiligaynon HIM Himachali Languages HIN Hindi HMO Hiri Motu HUN Hungarian HUP Hupa IBA Iban ICE Icelandic IDO Ido IBO Igbo IJO Ijo languages ILO Iloko INC Indic Languages INE Indo-European Languages IND Indonesian INH Ingush INT Interlingua (International Auxiliary Language Association) ILE Interlingue
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 62 of 69
INU Inuit languages IKU Inuktitut;Inuktut IPK Inupiaq IRA Iranian Languages IRI Irish MGA Irish, Middle (900-1200) SGA Irish, Old (to 900) IRO Iroquoian languages ITA Italian JPN Japanese JAV Javanese JRB Judeo-Arabic JPR Judeo-Persian KBD Kabardian KAB Kabyle KAC Kachin; Jingpho KAL Kalaallisut XAL Kalmyk; Oirat KAM Kamba KAN Kannada KAU Kanuri KRC Karachay-Balkar KAA Kara-Kalpak KRL Karelian KAR Karen languages KAS Kashmiri CSB Kashubian KAW Kawi KAZ Kazakh KHA Khasi KHI Khoisan Language KHO Khotanese; Sakan KIK Kikuyu KMB Kimbundu KIN Kinyarwanda KIR Kirghiz; Kyrgyz TLH Klingon; Tlhlngan-Hol KOM Komi KON Kongo KOK Konkani KOR Korean KOS Kosraean KPE Kpelle KRO Kru languages
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 63 of 69
KUA Kuanyama KUM Kumyk KUR Kurdish KRU Kurukh KUS Kusaie KUT Kutenai LAD Ladino LAH Lahnda LKT Lakota LAM Lamba DAY Land Dayak languages LAN Langue d’oc (post-1500) LAO Lao LAP Lapp LAT Latin LAV Latvian LTZ Letzeburgesch; Luxembourgish LEZ Lezghian LIM Limburgan LIN Lingala LIT Lithuanian JBO Lojban NDS Low German; Low Saxon LOZ Lozi LUB Luba-Katanga LUA Luba-Lulua LUI Luiseno LUN Lunda LUO Luo (Kenya and Tanzania) LUS Lushai MAC Macedonian MAD Madurese MAG Magahi MAI Maithili MAK Makasar MLA Malagasy MAY Malay MAL Malayalam MLT Maltese MNC Manchu MDR DMN
Mandar Mande languages
MAN Mandingo MNI Manipuri
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 64 of 69
MNO Manobo languages MAX Manx MAO Maori ARN Mapudungun; Mapuche (was Araucanian) MAR Marathi CHM Mari (Russia) MAH Marshallese MWR Marwari MAS Masai MYN Mayan languages MEN Mende MCH Michif MIC Micmac; Mi’kmaq MIN Minangkabau MWL Mirandese MIS Miscellaneous (Other) (No longer available see Uncoded
Languages) MOH Mohawk MDF Moksha MOL RUM
Moldavian (No longer available) Moldavian
LOL Mongo MON Mongolian MKH Mon-Khmer Languages MOS Mossi MUL Multiple languages MUN Munda (Other) NQO N’Ko NAH Nahuatl languages DAK Nakota NAU Nauru NAV Navajo NDE Ndebele, North NBL Ndebele, South NDO Ndonga NAP Neapolitan NEP Nepali NEW Newari NIA Nias NIC Niger-Kordofanian Languages/Niger-Congo SSA Nilo-Saharan Languages NIU Niuean NOG Nogai NON Norse, Old
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 65 of 69
NAI North American Indian Languages NSO Northern Sotho; Pedi NOR Norwegian NOB Norwegian, Bokmal NNO Norwegian, Nynorsk NUB Nubian languages NYM Nyamwezi NYA Nyanja NYN Nyankole NYO Nyoro NZI Nzima OCI Occitan (post 1500) OJI Ojibwa PEO Old Persian (ca. 600-400 B.C.) ORI Oriya GAL Oromo OSA Osage OSS Ossetian; Ossetic OTO Otomian languages PAL Pahlavi PAU Palauan PLI Pali PAM Pampanga PAG Pangasinan PAN Panjabi; Punjabi PAP Papiamento PAA Papuan Languages PUS Pashto PER Persian PEO Persian, Old (ca.600-400 B.C.) PHI Philippine Languages PHN Phoenician PON Pohnpeian POL Polish PON Ponape POR Portuguese PRA Prakrit languages PRO Provencal, Old (to 1500) PUS Pushto QUE Quechua RAJ Rajasthani RAP Rapanui RAR Rarotongan; Cook Islands Maori ROA Romance Languages
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 66 of 69
RUM Romanian (use for Moldavian and Moldovan) ROH Romansh (was Raeto-Romance) ROM Romany RUN Rundi RUS Russian SAL Salishan languages SAM Samaritan Aramaic SMI Sami languages SMN Sami, Inari SMJ Sami, Lule SME Sami, Northern SMS Sami, Skolt SMA Sami, Southern SAO Samoan SAD Sandawe SAG Sango SAN Sanskrit SAT Santali SRD Sardinian SAS Sasak SAU Saulteaux SCO Scots SEL Selkup SEM Semitic Languages SCC Serbian (No Longer Available – use SRP) SRP SRR
Serbian Serer
SHN Shan SHO Shona III Sichuan Yi SCN Sicilian SID Sidamo SGN Sign Languages BLA Siksika (Blackfoot) SND Sindhi SNH Sinhalese SIT Sino-Tibetan SIO Siouan languages SIO Sioux DEN Slave, Athapascan SLA Slavic (Other) SLO Slovak SLV Slovenian SOG Sogdian
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 67 of 69
SOM Somali SON Songhai languages SNK Soninke WEN Sorbian languages DSB Sorbian, Lower HSB Sorbian, Upper SSO Sotho SAI South American Indian Languages ALT Southern Altai SPA Spanish SRN Sranan Tongo SUK Sukuma SUX Sumerian SUN Sundanese SUS Susu SWA Swahili SSW Swati SWZ Swazi SWE Swedish GSW Swiss German TAG Tagalog TAH Tahitian TAI Tai languages TAJ Tajik TMH Tamashek TAM Tamil TAR Tatar TEL Telugu TER Tereno TET Tetum THA Thai TIB Tibetan TIG Tigre TIR Tigrinya TEM Time TIV Tiv TLI Tlingit TPI Tok Pisin TKL Tokelau TOG Tonga, Nyasa TON Tonga, Tonga Islands TRU Truk TSI Tsimshian TSO Tsonga
Ministry of Education Employment and Additional Data XML Specifications
Updated August 2016
Page 68 of 69
TSW Tswana TUM Tumbuka TUP Tupi languages TUR Turkish OTA Turkish, Ottoman TUK Turkmen TVL Tuvalu TYV Tuvinian TWI Twi UDM Udmurt UGA Ugaritic UIG Uighur UKR Ukrainian UMB MIS
Umbundu Uncoded Languages
UND Undetermined URD AZC
Urdu Uto-Aztecan languages
UZB Uzbek VAI Vai VEN Venda VIE Vietnamese VOL Volapuk VOT Votic WAK Wakashan languages WAL Walaitta WLN Walloon WAR Waray WAS Washo WEL WAL
Welsh Wolaitta; Wolaytta
WOL Wolof XHO Xhosa SAH Yakut YAO Yao YAP Yapese YID Yiddish YOR Yoruba YPK Yupik languages ZND Zande languages ZAP Zapotec ZZA Zaza; Dimili ZEN Zenaga ZHA Zhuang