xml dialogues - saskatchewan · web viewrevision history 3 purpose of this document 8 student data...

XML for The Ministry of Education’s Student Data SystemUpdated May 2023

Table of Contents

Revision History..................................................................................................................3Purpose of this Document....................................................................................................8Student Data System XML Dialogues.................................................................................8

Typical Dialogues............................................................................................................8Ministry of Education K-12 XML Specification...............................................................10

1. Objects................................................................................................................111.1 SchoolTerm.........................................................................................................111.2 SchoolClass.........................................................................................................111.3 StudentSchoolEnrollment...................................................................................121.4 StudentProgramEnrollment................................................................................121.5 StudentPersonal..................................................................................................131.6 StudentClassEnrollment.....................................................................................131.7 StudentExamRegistration...................................................................................141.8 StudentClassMark...............................................................................................141.9 StudentSupplementalMark.................................................................................141.10 StudentCourseHistory.........................................................................................151.11 StudentExternalCourse.......................................................................................151.12 StudentEnrollment..............................................................................................151.13 StudentCourseEnrollments.................................................................................181.14 StudentCompletedCourses..................................................................................201.15 DeptCourses........................................................................................................211.16 AllStudentClassEnrollments...............................................................................221.17 StudentNotReEnrolled........................................................................................231.18 TSLStudentDeptMarks – No Longer Used........................................................231.19 Student PAAModule...........................................................................................232. Elements.............................................................................................................242.1 TermInfo.............................................................................................................242.2 ClassIdentification..............................................................................................252.3 ClassInfo.............................................................................................................252.4 StudentIdentification...........................................................................................262.5 StudentInfo.........................................................................................................272.6 SchoolEnrollmentInfo.........................................................................................362.7 ProgramEnrollmentInfo......................................................................................402.8 ClassEnrollmentInfo...........................................................................................402.9 ExamRegistrationInfo.........................................................................................412.10 ExamLocation.....................................................................................................422.11 SchoolMarkInfo..................................................................................................422.12 StudentCourseInfo..............................................................................................432.13 StudentExternalCourseInfo.................................................................................442.14 StudentClass.......................................................................................................452.15 StudentDeptExam...............................................................................................452.16 CompletedCourse...............................................................................................462.17 DeptCourse.........................................................................................................473. Queries................................................................................................................48

of 91


3.1 SL_Query............................................................................................................483.2 GeneralQuery......................................................................................................503.3 QueryByStudent.................................................................................................513.4 QueryBySchool...................................................................................................524. Message Infrastructure........................................................................................564.1 SL_Message........................................................................................................564.2 SL_Header..........................................................................................................574.3 SL_UserCredentials – removed from specification............................................584.4 SL_Event............................................................................................................584.5 SL_Request.........................................................................................................594.6 SL_Response......................................................................................................604.7 SL_Ping..............................................................................................................63

Appendix A – Country, Language and Province/State Codes...........................................65Appendix B – Additional Edits..........................................................................................84

SchoolId.........................................................................................................................86SchoolClass....................................................................................................................86StudentSchoolEnrollment..............................................................................................86StudentClassEnrollment................................................................................................87StudentClassMark..........................................................................................................88StudentSupplementalMark............................................................................................88StudentInfo....................................................................................................................89SL_Query.......................................................................................................................90Automatic Setting of End Dates....................................................................................91

of 91


Revision History

Date Version Changes2003 Sep 30 Pre-release Object StudentExamRegistration (2.14) added.

Diagrams of objects updated to reflect 2.14.Note added under StudentSectionEnrollment.OtherId code for SIN removed (will not be used).

2003 Oct 6 Pre-release Changed capitalization on the following (for consistency):ClassID changed to ClassIdLearningIDNumber changed to LearningIdNumberSL_MsgID changed to SL_MsgIdSL_SourceID changed to SL_SourceIdSL_UserID changed to SL_UserId

Corrected SLSourceID to SL_SourceId in specification (examples already had the underscore).

2003 Oct 7 Pre-release Changed capitalization on the following (for consistency):CountryofBirth changed to CountryOfBirthCountryofCitizenship changed to CountryOfCitizenshipMediumofInstruction changed to MediumOfInstruction

Changed LastName to allow spaces in the name.Specified that Email has to have exactly one @ character.Corrected some conditions in section 5 Transactions (objects required for transmitting student marks).

2003 Oct 8 Pre-release Character restrictions added to FirstName, MiddleName, Suffix and PreferredName.

2003 Oct 9 Pre-release SL_SourceId clarified to be department assigned numberSchoolYear format changed from YYYY to YYYY-YYYY

2003 Oct 15 Pre-release Action “Delete” added – allowed only for StudentSchoolEnrollment and StudentSectionEnrollment.Attribute Reason added to SL_Event to support action of “Delete”.Additional languages added to language code table, some codes changed.

2003 Oct 23 Pre-release Moved PreviousProvState and PreviousCountry from StudentPersonal to StudentSchoolEnrollmentClarified enrollment types and outcomes for out-of-province home-based schooling.

2003 Oct 24 Pre-release Added StudentExamRegistration to the table indicating minimal XML for each complete transaction (section 5).

2003 Oct 27 Pre-release Added a separate language code for Michif.2003 Oct 29 Pre-release Changed the xmlns string. Added attributes xmlns:xsi and

xsi:schemaLocation to SL_Message.Street element of Address changed from optional to required.

2003 Oct 31 Release 1.0 Released.2003 Nov 13 Release 1.0 Added program code for Special Education

of 91


Date Version Changes2003 Nov 24 Release 1.0 Date format changed to YYYY-MM-DD (from

YYYYMMDD).SL_Query changed – SL_QueryObject tag goes around variables now.

2003 Dec 3 Release 1.1 Reorganization of objects so that each object is a complete transaction.Some elements and attributes renamed.Some elements reordered.Some codes changed from numeric to mnemonic.Edit rules incorporated from previously separate document.Response status code values added.Message severity code of “severe error” dropped.Please contact Saskatchewan Learning if you wish to see a complete list of changes.

2003 Dec 4 Release 1.1 SchoolMarkInfo CorrectionCode made optional (defaults to No).PhoneNumber Type made optional (defaults to Home).SL_Header Zone made optional (defaults to Central Standard Time).Attribute ObjectData within SL_Response/SL_Ack/ SL_Error renamed to ObjectName (for consistency).

2003 Dec 9 Release 1.1 PostalCode made optional for physical addresses.Default added for ScopeCode if not specified in SL_Query.Added edits: Term end date must be within school year indicated. Class end date must not be before start date. Receiving new primary e-mail address will

automatically end-date previous primary e-mail address. Class enrollment exit date (dropped date) cannot be

before class start date.Some other edits clarified (not changed in intent).

2003 Dec 12 Release 1.1 Guidelines for how to create SL_MsgId added.2004 Jan 5 Release 1.1 Canal Zone (CZ) dropped from list of Canadian provinces

and U.S. states – no longer a part of the U.S.2004 Jan 13 Release 1.1 Added new Language codes. 2004 Jan 14 Release 1.1 Sending student’s program enrollment in school enrollment

object allowed (for “add” object only).Encoding attribute added to SL_Password.

2004 Jan 15 Release 1.1 See changes made in Appendix B (additional edits).2004 Jan 19 Release 1.1 Object StudentChallengeMark removed. Course challenge

marks cannot be submitted via XML according to department policy (they require appropriate paperwork).

2004 Jan 29 Release 1.1 Grade is required for enrollment of a new student.

of 91


Date Version Changes2004 Feb 5 Release 1.1 SL_UserCredentials removed from the specification – users

will have to provide userid and password in order to send the XML.

2004 Feb 19 Release 1.1 SL_EventObject added to SL_ObjectData in SL_Response, to be consistent with SL_ObjectData in SL_Event.ExitDate dropped from object ProgramEnrollmentInfo.

2004 Feb 25 Release 1.1 ExitType required when ExitDate provided in SchoolEnrollmentInfo.

2004 Feb 26 Release 1.1 New grade code added to distinguish two levels of pre-kindergarten.Clarification added regarding changing country of citizenship and language(s) used in the home.New edit and warning messages added (see Appendix B).

2004 Feb 27 Release 1.1 End date of term must fall between Sept 1 and Aug 31 (rather than Aug 1 and July 31).References to rules for internal use by Saskatchewan Learning added. Vendors can ignore these.

2004 Mar 25 Release 1.1 Restrictions added on what school enrollment data can be changed after initial submission.Restrictions noted on registering a student for a supplemental or adult challenge dept exam (writing centre has to be approved).

2004 Mar 29 Release 1.1 SL_QueryObject made repeatable and RefId added to it as a mandatory attribute

2004 May 10 Release 1.1 Names of programs updated; 2 French programs added2004 Jun 21 Release 1.1 Added “Saulteaux” to the list of languages2004 Nov 17 Release 1.1 Any date within the exam period will be accepted for the

ExamPeriodEndDate (does not have to be the last day of the exam period)

2004 Dec 2 Release 1.1 System will automatically register students in dept exams if mark source is “blended” and dept exam registration is not provided.

2005 Feb 23 Release 1.1 Clarified that enrolment start date can be changed to an earlier date (but not later).Clarified that ClassId must be an unchanging identifier.

2005 May 11 Release 1.1 Clarification of usage of enrollment type codes

2005 Jun 2 Release 2.0 Object StudentExternalCourse addedElement StudentExternalCourseInfo added

2005 Jul 8 Release 2.0 New ExitType added for discontinued with other reason2005 Aug 29 Release 2.0 Objects StudentEnrollment, StudentCourseEnrollments,

StudentCompletedCourses and DeptCourses addedElements StudentClass, StudentDeptExam, CompletedCourse and DeptCourse added

of 91


Date Version Changes2005 Aug 29 Release 2.0 Support for objects SL_QueryObject and

StudentCourseHistory removed (still supported in Release 1.1)Support for Element StudentCourseInfo removed (still supported in Release 1.1)

2005 Sep 14 Release 2.0 Object AllStudentSchoolEnrollments addedEvent Reason value “ToAllowReplacement” added

2005 Sep 21 Release 2.0 In Object AllStudentSchoolEnrollments, ClassEndAfterDate renamed to ClassEndFromDate, and ClassEndBeforeDate renamed to ClassEndToDate, and meanings changed to include classes ending on these dates.

2007 Sep 6 Release 2.0 Created New Object Name StudentNotReEnrolledwithin the QueryBySchool Object.

2007 Sep 13 Release 2.0 Created new Discontinuation Reason Code of Discontinued Schooling, with a reason of monitored.

2008 Feb 4 Release 2.0 Changed Grade from Optional to Required in Object 1.12 StudentEnrollment

2009 Apr 06 Release 2.0 Created new Enrolment Outcome Code of “Completed Functional Integrated Program”.

2009 Apr 06 Release 2.0 Created New Object Name StudentPAAModule.

2009 Apr 06 Release 2.0 Created new Program “Alternative Adult Secondary Program”

2009 Jul 14 Release 2.0 Changed the EducatorCertificateNumber in the ClassInfo Object to be Required and Repeatable rather than Optional and Repeatable.

2009 Aug 31 Release 2.0 Country Codes – Added new ones and changed some old ones.

2009 Aug 31 Release 2.0 Language Codes - Added new ones and changed some old ones.

2010 Jun 06 Release 2.0 Addition of Homebound Indicator, Immersion Type, and Tuition Status to the SchoolEnrollmentInfo Element.Addition of Country of Origin and Saskatchewan Resident to the StudentInfo Element.Addition of Permanent Physical Address Municipality and Land Location details to the StudentInfo Element.

of 91


2011 Nov 23 Release 2.0 Added ePPP element and object, Intensive Supports element and object, organization affiliation, home room teacher, preKindergarden (Ministry Designated, Shared Space) fields to StudentEnrollment object and SchoolEnrollment object.

2011 Dec 7 Release 2.0 Changes to Language and Country codes are in blue and additions are in orange.

2011 Dec 8 Release 2.0 Added Educator element, objects, and query. Note: This is to support Special Education.

2013 Jan 9 Release 3.0 Combined V1 and V2 of the schema into V3. Changed SL_Message headers to reflect new version.

2013 Jan 10 Release 3.0 Added Resident Type. Removed PreK Shared Space indicator and Tuition Status – length, Collected, and Exchange Program

2013 Jan 10 Release 3.0 Removed all objects relating to Educator, ePPP, EAL, and Intensive Supports. Created new version of schema for Educator and new version of schema for EAL and Intensive Supports. ePPP is now eIIP and is not currently available by XML.

2013 Apr 17 Release 3.0 Changed the spelling of 1.17 StudentsNotReenrolled to StudentNotReenrolled to reflect what is in the schema. This has been misspelled since implementation. pages 1 and 23

2013 Apr 17 Release 3.0 Changed the description of Demographics/CountryOfOrigin on page 28

2013 Apr 17 Release 3.0 Changed the implementation of ResidentType to IsResident on page 32 and 34 and added an example on page 35

2013 Dec 16 Release 3.0 Added Home Room Identifier in order to handle multiple home rooms assigned to the same Home Room Teacher.

2014 Dec 12 Release 4.0 Added new Enrollment Type Codes. Removed Code 01. See Page 38.Added new Enrollment Outcome and Discontinuation Reason Codes. Removed Code 01. See page 39Changed Foreign Tuition to Tuition. Page 40

of 91


Purpose of this Document

This document presents the format of XML for exchanging Student Data System information between partners. It does not address the technology of transmitting and receiving messages (see the Powerpoint presentation for information on the transport layer).

Student Data System XML Dialogues

An XML dialogue, whether real-time or batch, consists of one or more messages sent from a school to the Ministry of Education, and one or more messages sent from the Ministry of Education back to the school (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 school 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

of 91


of 91


Ministry of Education K-12 XML Specification

The Ministry of Education (MOE) K-12 XML specification defines how XML is structured for communication between schools and The Ministry of Education. It was designed using the Schools Interoperability Framework (SIF) Implementation Specification (see www.sifinfo.org) as a starting point, but is not compliant with SIF.

The MOE K-12 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 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 and in Appendix B. Any element or attribute that is not considered valid will be rejected and could cause the rejection of the entire object it is part of. 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 a student’s Learning ID 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., one query asks for course information on all students enrolled in a term), all the returned objects will include the RefId of the query.

In the MOE K-12 XML specifications: *IMPORTANT* 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.

The “Required” and “Optional” status of elements in this document refer to object-element and complex element relationships only. This status does not propose to constitute specific Ministry data requirements but rather describes xml element relationships only.

Elements can have multiple values only if the specification indicates that they are “repeatable”.

Note that references to rules – e.g., (rule DAT-LE-058) or (rule enforced by database constraint) – are for internal use by the Ministry of Education. Vendors can ignore these.

of 91


1. ObjectsThe following objects support transmission of data between schools and The Ministry of Education. Schools 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.4 SL_Event for more information on action codes.

Objects are also used to return data from the Ministry of Education to schools, 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 SchoolTermThis object allows the school to set up their terms, including a brief description or name of each term. It is optional – The Ministry of Education will automatically create terms (without descriptions or names) to support classes sent by the school.

Element Attribute Status Description/NotesSchoolTerm

RefId Required The reference ID for returning messages.SchoolId Required The department-assigned number of the

school the term is for.TermInfo Required Element 2.1

1.2 SchoolClassThis object allows the school to set up classes being offered. A class has to be created before students can be registered in it.

Note: A class is loosely defined as a group of students who meet together to learn the same subject matter from the same educator(s) at the same time. In the elementary and middle levels, a single class might cover several courses (e.g., English Language Arts, Mathematics, Social Studies, Science, etc.) and even multiple grades (split class). For grades 10 to 12, each class can cover only one course.

Element Attribute Status Description/NotesSchoolClass

RefId Required The reference ID for returning messages.ClassIdentification Required Element 2.2ClassInfo Required Element 2.3

of 91


1.3 StudentSchoolEnrollmentThis object allows the school to enroll an existing or new student in their school, or to update enrollment information.

Element Attribute Status Description/NotesStudentSchoolEnrollment

RefId Required The reference ID for returning messages.StudentIdentification Required Element 2.4StudentInfo Optional Note: Required if DeptAssignedPersonId

is not included in StudentIdentification. Element 2.5

SchoolId Required The department-assigned number of the school the enrollment is for.

SchoolEnrollmentInfo Required Element 2.6DeptAssignedProgramId Optional The department-assigned number of the

program the student is enrolling in (see under 1.4 StudentProgramEnrollment). Note: this element is allowed only when adding a StudentSchoolEnrollment. The object StudentProgramEnrollment is used to change a student’s program.

ProgramEnrollmentInfo Optional Note: this element is allowed only when adding a StudentSchoolEnrollment. The object StudentProgramEnrollment is used to change a student’s program. Element 2.7

1.4 StudentProgramEnrollmentThis object allows the school to indicate or change the program the student is taking. It is only accepted from a school where the student is enrolled or being enrolled as a base student (rule SEC-ENROL-001).

Element Attribute Status Description/NotesStudentProgramEnrollment

RefId Required The reference ID for returning messages.StudentIdentification Required Element 2.4DeptAssignedProgramId Required The department-assigned number of the

program the student is enrolling in (see below).

ProgramEnrollmentInfo Required Element 2.7

Program Numbers10 Regular Program (English)11 Fransaskois Program – Francophone bilingue

of 91


12 French Immersion/Bilingual Program05 Alternative Education Program (English)06 Alternative Education Program (French) - Le Programme d'éducation alternative07 Functional Integrated Program (English)17 Functional Integrated Program (French) - Programme intégré fonctionnel09 Adult Secondary Program (English)16 Adult Secondary Program (French) - Éducation des adults18 Alternative Adult Secondary Program (English)15 Special Education Program (for students up to grade 9)

1.5 StudentPersonalThis object allows a school to update demographic information about a student who has already been enrolled as a base student (rule SEC-DEMO-002). When sent from a school, the only action that is allowed for this object is “Change”.

This object is also included in query response files and allows the Ministry of Education to return information to a school about a student’s demographic information, on request. See section 3 Queries for how to request this information.

Element Attribute Status Description/NotesStudentPersonal

RefId Required The reference ID for returning messages.StudentIdentification Required Element 2.4StudentInfo Required Element 2.5

1.6 StudentClassEnrollmentThis object allows a school to register a student in a class and the departmental exam for the class (if applicable). Note that the class must already exist. A class enrollment must exist before a mark will be accepted for it.

Element Attribute Status Description/NotesStudentClassEnrollment

RefId Required The reference ID for returning messages.StudentIdentification Required Element 2.4ClassIdentification Required Element 2.2ClassEnrollmentInfo Required Element 2.8ExamRegistrationInfo Optional Note: If not provided and the mark source is

“blended”, the system will register the student in the next available dept exam that is in an exam period ending on or after the class end date.Note: If included or the mark source is “blended”, the writing centre is assumed to be the school where the class is being taken, unless indicated otherwise. Element 2.9

of 91


1.7 StudentExamRegistrationThis object allows a school to register a student in a supplemental or adult challenge departmental exam (i.e., exam registration with no class). This object will be accepted only if the student qualifies to write the indicated type of exam according to department policy (see the policy on the department’s web site) (rule SDS-MARKS-006). The writing centre has to be approved to offer supplemental and adult challenge exams before the student can be registered (rule SDS-MARKS-015).

Element Attribute Status Description/NotesStudentExamRegistration

RefId Required The reference ID for returning messages.StudentIdentification Required Element 2.4DeptAssignedCourseId Required The department-assigned number of the

course whose exam the student plans to write.

ExamRegistrationInfo Required Element 2.9ExamLocation Required Element 2.10

1.8 StudentClassMarkThis object allows the school to submit or correct the school mark for a student who took a class. Note that the class enrollment must exist and an educator has to be identified for the class before the mark will be accepted (rule SDS-MARKS-002).

A StudentClassMark will not be accepted prior to the month in which the class ends (to avoid accidental use of mid-term marks) (rule DAT-STUREC-029).

Element Attribute Status Description/NotesStudentClassMark

RefId Required The reference ID for returning messages.StudentIdentification Required Element 2.4ClassIdentification Required Element 2.2SchoolMarkInfo Required Element 2.11

1.9 StudentSupplementalMarkThis object allows the school to submit or correct the school supplemental (rewrite) mark for a student. No class enrollment object for this mark is required, but the student has to have had a previous class enrollment and mark for the same course (rule SDS-MARKS-003).

Element Attribute Status Description/NotesStudentSupplementalMark

RefId Required The reference ID for returning messages.StudentIdentification Required Element 2.4

of 91


SchoolId Required The department-assigned number of the school granting the mark.

DeptAssignedCourseId Required The department-assigned number of the course for which the student is granted a mark.

EducatorCertificateNumber Required The educator certificate number of the educator who evaluated the student.

SchoolMarkInfo Required Element 2.11

1.10 StudentCourseHistoryThis object is included in applicable query response files only and allows the Ministry of Education to return information to a school about a student’s courses, on request. See section 3 Queries for how to request this information.

Element Attribute Status Description/NotesStudentCourseHistory

RefId Required The reference ID for returning messages.StudentIdentification RequiredDeptAssignedCourseId Required The department-assigned number of the

course the student took.CourseTitle Optional The name of the course the student took.StudentCourseInfo Required

1.11 StudentExternalCourseThis object allows the school to submit or correct a Driver Education course to be included on the student’s transcript. This object does not support the action “Delete”. (The courses sent by schools include final marks, and only internal users can delete courses with final marks.)

Element Attribute Status Description/NotesStudentExternalCourse

RefId Required The reference ID for returning messages.StudentIdentification Required Element 2.4StudentExternalCourseInfo Required

and Repeatable

We would encourage only one course per object so that error messages can be tied to a specific course. Element 2.13

1.12 StudentEnrollmentThis object is included in applicable query response files only and allows The Ministry of Education to return information to a school about a student’s current school, program and grade enrolment, on request. If requested for a specific student, previous school enrolment is also included. SchoolName and ProgramName will be included only if requested in the query. See section 3 Queries for how to request this information.

of 91


Element Attribute Status Description/NotesStudentEnrollment

RefId Required The object reference ID.StudentIdentification Required Element 2.4SchoolEnrollment Required

and Repeatable

Information about one school enrollment for the indicated student.

SchoolEnrollment/ SchoolId

Required The department-assigned number of the school the enrollment is in.

SchoolEnrollment/ SchoolName

Optional The current name of the school the enrollment is in.

SchoolEnrollment/ SchoolEnrollmentInfo

Required Information about the enrollment. Note that Grade will not be sent as part of this element (SchoolEnrollmentInfo), since it is a separate element in StudentEnrollment. Element 2.6.

DeptAssignedProgramId Optional The department-assigned number of the program the student is currently enrolled in, if applicable (see under 1.4 StudentProgramEnrollment).

ProgramName Optional The name of the program the student is currently enrolled in, if applicable.

Grade Optional The student’s grade in the current school year. There is no grade returned if there is no current grade enrolment.

Code Required Grade code (see codes under 2.6 SchoolEnrollmentInfo).

PreKSpaceInfo Optional Used for PreKindergarten Space Information.

PreKSpaceInfo/ MinistryDesignated

Optional Used for prekindergarten only. Yes or No. Defaulted to Yes.

ImmersionType Optional The type of immersion the student is enrolled in. Default is NA, if not included.

Code Required ImmersionType code (see codes under 2.6 SchoolEnrollmentInfo).

Homebound Optional Indicates whether a student is Homebound or not. Default is No, if not included.

Code Required Yes or No (see codes under 2.6 SchoolEnrollmentInfo).

of 91


CumulativeFolder Optional Indicates whether the student cumulative folder is located at this school. Default is No, if not included.

Code Required Yes or No (see codes under 2.6 SchoolEnrollmentInfo).

TuitionStatus Optional Indicates an exception to provincial tuition status. Default is NA, if not included.

Code Required TuitionStatus Code (see codes under 2.6 SchoolEnrollmentInfo)

OrganizationAffiliation Optional and Repeatable

Information about a student’s affiliation with other organizations for the current school year.

OrganizationAffiliation/ SchoolId

Required The department-assigned number of the affiliated organization.

HomeRoom Optional Required for students enrolling in Grades preK – 9.

HomeRoom/Educator CertificateNumber

Required The educator certificate number of the educator who presides over the student’s home room. Must be a valid 7-digit educator certificate number.

HomeRoom/HomeRoom Identifier

Optional 25 character alphanumeric field. Default to Educator Last name and first initial of first name, if not included in object.

Example<StudentEnrollment RefId = “1”>

<StudentIdentification> <DeptAssignedPersonId>123456789</DeptAssignedPersonId> <BirthDate>1996-10-31</BirthDate>

</StudentIdentification><SchoolEnrollment>

<SchoolId>1234455</SchoolId><SchoolEnrollmentInfo MembershipType=”Base”>

<EntryDate>2012-09-02</EntryDate></SchoolEnrollmentInfo>

</SchoolEnrollment><DeptAssignedProgramId>10</DeptAssignedProgramId><Grade Code=”PK”/><PreKSharedSpaceInfo>

<MinistryDesignated>Yes</MinistryDesignated></PreKSharedSpaceInfo><HomeRoom>

<EducatorCertificateNumber>1234567</EducatorCertificateNumber>

of 91


<HomeRoomIdentifier>TeachI</HomeRoomIdentifier></HomeRoom>

</StudentEnrollment>

1.13 StudentCourseEnrollmentsThis object is included in applicable query response files only and allows the Ministry of Education to return information to a school about a student’s class and department exam registrations, on request. Course registrations from all schools that are neither dropped nor completed are included. SchoolName will be included only if requested in the query. See section 3 Queries for how to request this information.

Element Attribute Status Description/NotesStudentCourseEnrollments

RefId Required The object reference ID.StudentIdentification Required Identification of the student. Element

2.4.StudentSchoolClasses Optional

and Repeatable

Information about classes the student is registered in at one school.

StudentSchoolClasses/ SchoolId

Required The department-assigned number of the school the registrations are at.

StudentSchoolClasses/ SchoolName

Optional The current name of the school the registrations are at.

StudentSchoolClasses/ StudentTermClasses

Required and Repeatable

Information about classes the student is registered in during a single term at the school identified by SchoolId.

StudentSchoolClasses/ StudentTermClasses/ TermInfo

Required Identification of the term the registrations are in. Element 2.1.

StudentSchoolClasses/ StudentTermClasses/ StudentClass


Information about a single class the student is registered in at the school identified by SchoolId, in the term identified by TermInfo. Element 2.14.

StudentDeptExam Optional and Repeatable

Information about a department exam the student is registered in, where the exam is not tied to a class. Element 2.15.

Example<StudentCourseEnrollments RefId = “1”>


</StudentIdentification><StudentSchoolClasses>

of 91


<SchoolId>2345678</SchoolId><StudentTermClasses>

<TermInfo SchoolYear=”2012-2013”><StartDate>2013-02-05</StartDate><EndDate>2013-06-25</EndDate>

</TermInfo><StudentClass>

<ClassId>6991-B1</ClassId><ModeOfInstruction Code=”Distance”/><MarkSource Code=”School”/>

</StudentClass></StudentTermClasses>

</StudentSchoolClasses><StudentSchoolClasses>

<SchoolId>5678901</SchoolId><StudentTermClasses>



<ClassId>BIO30-1</ClassId><ModeOfInstruction Code=”Class”/><MarkSource Code=”School”/>

</StudentClass><StudentClass>

<ClassId>GER30-1</ClassId><ModeOfInstruction Code=”Class”/><MarkSource Code=”School”/>

</StudentClass><StudentClass>

<ClassId>ELAA30-2</ClassId><ModeOfInstruction Code=”Class”/><MarkSource Code=”Blended”/><ExamPeriodEndDate>2013-01-28</ExamPeriodEndDate>

</StudentClass></StudentTermClasses><StudentTermClasses>



<ClassId>ELAB30-2</ClassId><ModeOfInstruction Code=”Class”/><MarkSource Code=”Blended”/><ExamPeriodEndDate>2013-06-28</ExamPeriodEndDate>

of 91


</StudentClass></StudentTermClasses>

</StudentSchoolClasses></StudentCourseEnrollments>

1.14 StudentCompletedCoursesThis object is included in applicable query response files only and allows the Ministry of Education to return information to a school about a student’s completed courses, on request. (A completed course is one with a final mark or standing granted.) SchoolName will be included only if requested in the query. See section 3 Queries for how to request this information.

Element Attribute Status Description/NotesStudentCompletedCourses

RefId Required The object reference ID.StudentIdentification Required Identification of the student. Element

2.4.CompletedSchoolCourses Optional

and Repeatable

Information about courses the student completed at one school.

CompletedSchoolCourse/ SchoolId

Required The department-assigned number of the school the courses were taken at.

CompletedSchoolCourse/ SchoolName

Optional The current name of the school the courses were taken at.

CompletedSchoolCourse/ CompletedCourse


Information about one course completed by the student. Element 2.16.

OtherCompletedCourses Optional Information about courses the student completed that are not associated with a Saskatchewan school (e.g., 100% dept exam and credit transfer).

OtherCompletedCourses/ CompletedCourse


Information about one course completed by the student. Element 2.16.

Example<StudentCompletedCourses RefId = “2”>


</StudentIdentification><CompletedSchoolCourses>

<SchoolId>2345678</SchoolId><CompletedCourse Type=”School”>

<DeptAssignedCourseId>6017</DeptAssignedCourseId>

of 91


<SchoolYear>2011-2012</SchoolYear><CourseEndDate>2012-01-28</CourseEndDate><FinalMark>78</FinalMark><CreditsEarned>1.0</CreditsEarned>

</CompletedCourse><CompletedCourse Type=”School”>

<DeptAssignedCourseId>6702</DeptAssignedCourseId><SchoolYear>2011-2012</SchoolYear><CourseEndDate>2012-01-28</CourseEndDate><FinalMark>73</FinalMark><CreditsEarned>1.0</CreditsEarned>

</CompletedCourse></CompletedSchoolCourses><CompletedSchoolCourses>



</CompletedCourse></CompletedSchoolCourses><OtherCompletedCourses>

<CompletedCourse Type=”Transfer”><DeptAssignedCourseId>4511</DeptAssignedCourseId><CourseEndDate>2011-06-28</CourseEndDate><FinalMark>80</FinalMark><CreditsEarned>1.0</CreditsEarned>

</CompletedCourse></OtherCompletedCourses>

</StudentCompletedCourses>

1.15 DeptCoursesThis object is included in applicable query response files only and allows the Ministry of Education to return a list of all active grade 10-12 department-defined courses to a school, on request. See section 3 Queries for how to request this information.

Element Attribute Status Description/NotesDeptCourses

RefId Required The object reference ID.DeptCourse Required

and Repeatable

Information about one course. Element 2.17

of 91


Example<DeptCourses RefId="1"> <DeptCourse>

<DeptAssignedCourseId>6211</DeptAssignedCourseId> <CourseTitle>Biology 20</CourseTitle>

<Grade Code=”11”/> <CreditValue>1</CreditValue> <EffectiveDate>1992-08-16</EffectiveDate> </DeptCourse>

<DeptCourse>. . . </DeptCourse>

</DeptCourses>

1.16 AllStudentClassEnrollmentsThis object allows the school to delete all class registrations for classes at their school whose class end date is on/after a specified date or within a specified date range, as requested. This allows the school to resubmit corrected class registrations.

This object supports only the action “Delete”. SL_EventObject Action must be “Delete” and SL_EventObject Reason must be specified (it would normally be “ToAllowReplacement”).

Note: Class registrations are deleted for classes offered by the specified school, whether the student is a base or non-base student at the school, and regardless of whether or not the registration was originally created by XML. Classes taken by the same students at other schools are not touched.

Note: Only registrations for 100% school marks will be deleted, and only if there is no school mark yet. Blended registrations cannot be deleted in this manner. If processing results in all students being deleted from the class, the empty class will be deleted.

Element Attribute Status Description/NotesAllStudentClassEnrollments

RefId Required The reference ID for returning messages.SchoolId Required The department-assigned number of the

school whose class registrations are to be deleted.

ClassEndFromDate Required Class registrations will be deleted only for classes whose end date is on or after this date.

ClassEndToDate Optional If this date is specified, class registrations will be deleted only for classes whose end date is on or after ClassEndFromDate and on or before

of 91


ClassEndToDate.

<AllStudentClassEnrollments RefId="1"> <SchoolId>1234567</SchoolId>

<ClassEndFromDate>2012-10-15<\ClassEndFromDate></AllStudentClassEnrollments>

1.17 StudentNotReEnrolledThis object is included in applicable query response files only and allows the Ministry of Education to return information to a school about students that are no longer enrolled in the school, but that were enrolled at one time and are less than 16 years of age. See section 3 Queries for how to request this information.

Element Attribute Status Description/NotesStudentNotReEnrolled

RefId Required The object reference ID.StudentIdentification Required Element 2.4SchoolId Required The department-assigned number of the

school StudentAddress Optional The last known address for the student

See StudentInfo for the sub elements of StudentAddress

PhoneNumber Optional See StudentInfo for the subelements of PhoneNumber

1.18 TSLStudentDeptMarks – No Longer Used

1.19 Student PAAModule

This object allows the school to submit PAA Module information.

Element Attribute Status Description/NotesStudentPAAModule

RefID Required The reference ID for returning messages.StudentIdentification Required Element 2.4.PAAModule Required

and repeatable

Information about Modules the student has completed.

ModuleId Required Identification of the ModuleSchoolId Required The Department Assigned Number of the

school where the module was completed.

of 91


SchoolYear Required The school year the module was considered to be part of, expressed as both four-digit calendar years that the school year spans with a hyphen between (e.g. 2009-2010)

Example<SL_EventObject ObjectName=”StudentPAAModule” Action=”Add”>

<StudentPAAModule RefId=”1059998”><StudentIdentification>

<DeptAssignedPersonId>1234567</DeptAssignedPersonId><BirthDate>1999-10-20</BirthDate>

</StudentIdentification><PAAModule>

<ModuleId>144</ModuleId><SchoolId>1234567</SchoolId><SchoolYear>2012-2013</SchoolYear>

</PAAModule> </StudentPAAModule>

</SL_EventObject>

2. ElementsThese elements are used within the objects described in section 1 Objects.

2.1 TermInfoElement Attribute Status Description/NotesTermInfo Identifies and describes a term

SchoolYear Required The school year of the term, expressed as both four-digit calendar years that the school year spans with a hyphen between (e.g. "2012-2013")

StartDate Required Start date of the termEndDate Required End date of the term. Cannot be before StartDate

(rule DAT-GEN-002). Must be within the school year indicated (between Aug 1 of the first calendar year and Jul 31 of the second calendar year) (rule DAT-PGM-010).

Description Optional Text name or description of the term

Example<TermInfo SchoolYear=”2012-2013”>

<StartDate>2013-02-05</StartDate><EndDate>2013-06-28</EndDate><Description>2012-13 Semester 2</Description>

</TermInfo>

of 91


2.2 ClassIdentificationElement Attribute Status Description/NotesClassIdentification Identifies a classSchoolId Required The department-assigned number of the

school offering the class.ClassId Required Unique identifier (not case sensitive)

assigned by the school to distinguish this class from all other classes in the same school for the same dates. Note: This can be formed any way the school finds convenient (e.g., course abbreviation and section letter for grades 10 to 12), as long as it never changes once the class has been created. The ClassId of an existing class cannot be changed.

StartDate Required First day of the term the class is inEndDate Required Last day of the term the class is in. Cannot

be before StartDate (rule DAT-GEN-002).

Example<ClassIdentification>

<SchoolId>1234567</SchoolId><ClassId>ELA20A</ClassId><StartDate>2013-02-05</StartDate><EndDate>2013-06-28</EndDate>

</ClassIdentification>

2.3 ClassInfoElement Attribute Status Description/NotesClassInfo Describes a classDeptAssignedCourseId Optional

and Repeatable

Identification of the course(s) covered by the class, using department-assigned course numbers. Required when creating a class (rule DAT-PGM-016). There can only be one course per class in grades 10 to 12 (rule DAT-PGM-003). All courses must be active as of the StartDate of the class (rule DAT-PGM-013).

EducatorCertificateNumber Required and Repeatable

The teacher(s) who teach this class, identified by their educator certificate numbers. Must be a valid 7-digit educator certificate number.

of 91


ModeOfInstruction Optional How students receive instruction for this class (can be overridden for individual students). Defaults to “classroom instruction” if not specified (rule DAT-PGM-015).

Code Required Mode of instruction (see below)

Mode of Instruction ValuesClass Classroom instruction (default if not specified)Distance Distance learning

Example<ClassInfo>

<DeptAssignedCourseId>6017</DeptAssignedCourseId><EducatorCertificateNumber>1234567</EducatorCertificateNumber><ModeOfInstruction Code=”Class”/>

</ClassInfo>

2.4 StudentIdentificationUsed to identify a student (in conjunction with information in StudentInfo if the Learning ID Number is not known). If DeptAssignedPersonId (Learning ID Number) is included and BirthDate does not match the student’s birth date in the department’s database, the object containing this element is rejected (rule SDS-DEMO-001).

Element Attribute Status Description/NotesStudentIdentification Identifies a student (in conjunction with

information in StudentInfo if the Learning ID Number is not included).

DeptAssignedPersonId Optional Learning ID Number (assigned by The Ministry of Education). Required in all objects except StudentSchoolEnrollment. Must be a 9-digit number that exists on the department database (rule DAT-LE-058).

BirthDate Required The student'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 student.

Example<StudentIdentification>

<DeptAssignedPersonId>123456789</DeptAssignedPersonId> <BirthDate>1993-10-31</BirthDate>

</StudentIdentification>

of 91


2.5 StudentInfoThis element is used to enroll a student (in object StudentSchoolEnrollment) and to update demographic information about a base student (in object StudentPersonal).

Note that if the student 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) (rule SDS-DEMO-001). If the Ministry database has the HSN for an existing student, the HSN cannot be changed via XML (rule SDS-DEMO-011).

Element Attribute Status Description/NotesStudentInfo Provides information about a student. SchoolAssignedPersonId Optional Student number assigned by the

schoolHSN Optional Saskatchewan Health Services

Number. If known, should be provided when enrolling a student if the DeptAssignedPersonId is not included. Must be 9 digits and pass the check-digit edit (rule DAT-LE-050).

Name Optional and Repeatable

Student's name(s). Legal name is required (rule DAT-LE-024) (and must contain only valid characters) if DeptAssignedPersonId is missing from StudentIdentification.

Type Required Name type (see below)Name/LastName Required Last name. Restricted to uppercase

and lowercase alpha characters, hyphens (-), apostrophes ('), periods (.) and spaces (rule DAT-LE-013).

Name/FirstName Required First name. Restricted to same characters as LastName (rule DAT-LE-013).

Name/MiddleName Optional Middle name or initial. Restricted to same characters as LastName (rule DAT-LE-013).

Name/Suffix Optional Name suffix like II, Jr., etc. Restricted to same characters as LastName (rule DAT-LE-013).

of 91


Name/PreferredName Optional Name the person prefers to be called by (e.g., "Rob"), not including the last name. For students, will be used to create an alias with PreferredName as the first name and LastName as the last name. The Ministry of Education will not return PreferredName. Restricted to same characters as LastName (rule DAT-LE-013).

Email Optional and Repeatable

Student's email address(es). Must contain exactly one @ character (rule DAT-LE-021).

Type Required Email type (see below)Demographics Optional

Demographics/Gender Optional Code that specifies the student's gender (see below). Required to create a new student (rule SDS-DEMO-002).

Demographics/ CountryOfBirth

Optional The student's country of birth

Code Required Country code (see appendix A)Demographics/ CountryOfCitizenship

Optional and Repeatable

The student's country(ies) of citizenship

Code Required Country code (see appendix A)Demographics/ CountryOfOrigin

Optional The student's country of origin. Required for students who have a Tuition Status other than SK-AB Lloyd Agreement, other Provincial Agreement, or NA

Code Required Country code (see appendix A)Demographics/Language

Optional and Repeatable

Language(s) the student uses in the home

Code Required Language code (see appendix A)Demographics/Deceased

Optional Information if the student is deceased

Code Required Deceased code (see below).EffectiveDate Optional Death date or date death was known

Demographics/ AboriginalStatus

Optional The student's aboriginal status, if applicable.

Code Required Aboriginal status code (see below)

of 91


Demographics/ TreatyStatusNumber

Optional The student's treaty status number, if applicable. Will only be accepted from and sent to band schools (rule SEC-DEMO-001).

Number Required Treaty status numberStartDate Optional Effective start date of the treaty

status number. Defaults to date of XML if not specified.

EndDate Optional End date of the treaty status number. Ignored if before StartDate.

Demographics/ BandAffiliation

Optional The student's band affiliation, if applicable. Will only be accepted from and sent to band schools (rule SEC-DEMO-001).

Code Required Affiliated Band code (federally assigned number)

StartDate Optional Effective start date of the band affiliation. Defaults to date of XML if not specified.

EndDate Optional End date of the band affiliation. Ignored if before StartDate.

Demographics/ ReserveResidency

Optional The student's reserve residency, if applicable. Will only be accepted from and sent to band schools (rule SEC-DEMO-001).

Code Required Reserve residency code (see below)StartDate Optional Effective start date of the reserve

residency. Defaults to date of XML if not specified.

EndDate Optional End date of the reserve residency. Ignored if before StartDate.

StudentAddress Optional and Repeatable

The student's address information. Permanent mailing address is required to create a new student (rule SDS-DEMO-002).

StudentAddress/ Address

Required Detail of the student’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 if not specified.

of 91


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.

StudentAddress/ 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 send as one or more address lines and will also send as discrete elements if the address was received as discrete elements. Street is required for all address types except PhysicalLand.

StudentAddress/ Address/Street/Line1

Optional Address line 1. Required if discrete elements not included (rule DAT-LE-009). If StudentAddress/Address Type is Permanent Physical Municipality, Line 1 or discrete elements is required. If StudentAddress/Address Type is Permanent Physical Land, none of the municipal Street elements will be accepted.


Optional Address line 2.


Optional Address line 3.

StudentAddress/ Address/Street/ Complex

Optional Name of the complex

StudentAddress/ Address/Street/ StreetNumber

Optional The address number assigned to the building

StudentAddress/ Address/Street/ StreetPrefix

Optional Street prefix (e.g. SW, NE)

StudentAddress/ Address/Street/StreetName

Optional The name of the street

StudentAddress/ Address/Street/StreetType

Optional The type of the street (e.g. Lane, Blvd., Ave., etc.)

of 91


StudentAddress/ Address/Street/ StreetSuffix

Optional Street suffix (e.g. SE, NW)

StudentAddress/ Address/Street/ AptType

Optional Type of apartment (e.g. Suite)

StudentAddress/ Address/Street/ AptNumPrefix

Optional Apartment number prefix

StudentAddress/ Address/Street/ AptNumber

Optional The number of the apartment

StudentAddress/ Address/Street/ AptNumSuffix

Optional Apartment number suffix

StudentAddress/ 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

StudentAddress/ Address/Sec

Optional Section is Required if Quarter Section is provided.

StudentAddress/ Address/RL

Optional River Lot. Only accepted for AddressType of Permanent Physical Land. Either River Lot or Quarter Section must be included if AddressType is Permanent Physical Land

StudentAddress/ Address/Twp

Optional Township is required if AddressType is Permanent Physical Land

StudentAddress/ Address/Rge

Optional Range is required if AddressType is Permanent Physical Land

StudentAddress/ Address/Mer

Optional Meridian is required if AddressType is Permanent Physical Land

StudentAddress/ Address/City

Required The city part of the address

StudentAddress/ Address/StatePr

Optional The state or province code part of the address (required for North American addresses).

Code Required State or province code (as used by Canada Post).

StudentAddress/ Address/Country

Optional The country part of the address (assumed to be Canada if not provided).

Code Required Country code (see appendix A)

of 91


StudentAddress/ Address/PostalCode

Optional The postal code or ZIP code. Required for mailing addresses but not physical addresses (rule DAT-LE-009).

PhoneNumber Optional and Repeatable

The student’s phone number. Format is (###) ###-#### for North American phone numbers (rule DAT-LE-022).

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 if not specified.

EndDate Optional Effective end date of the phone number. Ignored if before StartDate.

SaskResident Optional The Saskatchewan Residency is defaulted to Yes, if not provided. See below.

IsResident Required Yes or No value that indicates if the student is a Sask Resident

Code Required If student is a Canadian Citizen, Resident Type must be N/A. If student has a relationship of type “base” and is a Saskatchewan Resident, the Resident Type must be Refugee, Permanent Resident, Temporary Resident, or N/A. If student is not a Saskatchewan Resident the Resident Type must be Student/Visitor Visa or N/A

StartDate Optional Defaults to date of XML if not specified.

EndDate Optional Date the Resident Type is ended.

Name Type ValuesLegal Current legal nameAlias Alias – any current or previous name by which the individual is or was known

Email Type ValuesPrimary Primary email addressAlternate Alternate email address

of 91


Gender ValuesM MaleF FemaleU Unknown

Deceased ValuesYes DeceasedNo Not deceased

Aboriginal Status Values

Treaty Treaty/Registered/Status IndianNS Non-Status IndianMetis MetisInuit Inuit/Inuk

Reserve Residency ValuesOn Living on reserveOff Living off reserve

Address Type ValuesMailing Permanent mailing address (default if not specified)TempMailing Temporary mailing addressPhysical Permanent physical address (no longer accepted)PhysicalMun Permanent physical address – municipalityPhysicalLand Permanent physical address – land location

Physical Land Location Values

QSec Quarter SectionNW, NE, SW, SE

Sec SectionNumbers 1 through 36 and 36A

RL River LotNumbers 1 through 73

Twp TownshipNumbers 1 through 67 and 19A, 27A, 42A, 43A, 45A, 46A, 47A, S, L

Rge RangeNumbers 1 through 34 and 13A, 21A, 24A, A, L

Mer MeridianNumbers 1, 2, and 3 and S

of 91


Phone Number Format ValuesNA North AmericanFF Free form

Phone Number Type ValuesHome Home telephone number (default if not specified)

IsResident Values

Yes Student is a Resident of SaskatchewanNo Student is not a Resident of Saskatchewan

Resident Type Values

REF RefugeePM Permanent ResidentTR Temporary ResidentSVV Student/Visitor VisaNA Not Applicable

NoteIf the school does not have the student’s Learning ID Number at the time it enrolls the student, it may send the StudentSchoolEnrollment without the DeptAssignedPersonId (using student name and birthdate as identifiers). The Ministry of Education will return the Learning ID Number to the school in the response (as the DeptAssignedPersonId). If the Learning ID Number cannot be returned immediately (due to a time delay in manually verifying whether the student matches a record already on file), the response will indicate that the Learning ID Number will be sent later. Subsequent XML from the school for the same student must include the Learning ID Number.

If the student has more than one country of citizenship, send all countries each time an update is made to country of citizenship. For example, if the first message indicated Canada and U.S. and this needs to be corrected to Canada and France, send both Canada and France in the same object when making the correction. Similarly for languages used in the home – when changing the student’s languages, send all languages used in the home.

ExamplesSending a new student (Learning ID Number not yet known):

<StudentInfo> <HSN>987654321</HSN> <SchoolAssignedPersonId>12345</SchoolAssignedPersonId> <Name Type="Legal">

<LastName>Smith</LastName>

of 91


<FirstName>Kathleen</FirstName><MiddleName>Anne</MiddleName><PreferredName>Kathy</PreferredName>

</Name><Name Type="Alias">

<LastName>Jones</LastName><FirstName>Kathleen</FirstName><MiddleName>Anne</MiddleName><PreferredName>Kathy</PreferredName>

</Name><Email Type="Primary">[email protected]</Email> <Email Type="Alternate"> [email protected]</Email> <Demographics>

<Gender>F</Gender> <CountryOfBirth Code="US"/> <CountryOfCitizenship Code="CA"/> <CountryOfCitizenship Code="US"/><CountryOfOrigin Code=”US”/><Language Code="ENG"/>

</Demographics> <StudentAddress>

<Address Type="Mailing"> <Street>

<StreetNumber>1234</StreetNumber> <StreetName>Main</StreetName> <StreetType>St.</StreetType>

</Street> <City>AnyTown</City> <StatePr Code="SK"/> <Country Code="CA"/> <PostalCode>S0K 2P0</PostalCode>

</Address> </StudentAddress> <PhoneNumber Format="NA" Type="Home">(306) 123-4567</PhoneNumber> <SaskResident IsResident=”Yes” Code=”SW” StartDate=”2013-02-25” EndDate=”2015-07-31”/>

</StudentInfo>

Note that the above will result in a legal name of Kathleen Anne Smithand three aliases: Kathy Smith Kathleen Anne Jones Kathy Jones

of 91


Sending updates to an existing student (update e-mail address and mailing address):

<StudentInfo> <Email Type="Primary">[email protected]</Email> <StudentAddress>

<Address Type="Mailing" StartDate=”2012-09-23”> <Street>

<Line1>Box 1234</Line1> </Street> <City>AnyTown</City> <StatePr Code="SK"/> <Country Code="CA"/> <PostalCode>S0K 2P0</PostalCode>

</Address> </StudentAddress>

</StudentInfo>

Note that the new permanent mailing address is sent with its effective date. This will also be used to end date the previous permanent mailing address for this student.

2.6SchoolEnrollmentInfoThis element is used to enroll a student in a school or to update school enrollment information. Note that if an enrollment has already been ended (i.e., via a previous XML message or via the web interface), only the ExitType, ImmersionType, Homebound Indicator, and the Tuition Status can be updated (rule SDS-ENROL-004).

Element Attribute Status Description/NotesSchoolEnrollmentInfo Information about a student’s

enrollment in a schoolMembershipType

Optional Relationship of student to the indicated school (see below). Defaults to “Base” if not specified when enrolling a student.

EntryDate Optional The date from when this enrollment is valid. Required when enrolling a student (rule enforced by database constraint). Optional when changing an enrollment, but cannot be used to change the start date of an existing enrollment to a later date (rule SDS-ENROL-004).

EntryType Optional Required when enrolling a student (rule enforced by database constraint).

Code Required Enrollment type code (see below)

of 91


Grade Optional Required for MembershipType of “Base” and Optional for “Other”. The student’s grade in the current school year

Code Required Grade code (see below)PreKSpaceInfo Optional Used for PreKindergarten Space

Information. PreKSpaceInfo/ MinistryDesignated

Optional Used for prekindergarten only. Yes or No. Defaulted to Yes.

PreviousProvState Optional The province from which the student transferred, if applicable

Code Required Canadian province code as used by Canada Post

PreviousCountry Optional The country from which the student transferred, if applicable

Code Required Country code (see appendix A)ExitDate Optional The ending date of this enrollmentExitType Optional Required when ExitDate is included.

Code Required Code indicating enrollment outcome and, if student discontinued, discontinuation reason (see below)

ImmersionType Optional The type of immersion the student is enrolled in. Default to NA if not provided.

Code Required ImmersionType code (see below).Homebound Optional Indicates whether a student is

Homebound or not. Default is No, if not provided.

Code Required Yes or No (see below).CumulativeFolder Optional Indicates whether the student

cumulative folder is located at this school. Default is No, if not provided.

Code Required Yes or No (see below).TuitionStatus Optional Indicates an exception to provincial

tuition status. Default is NA, if not provided

Code Required TuitionStatus Code (see below)OrganizationAffiliation Optional

and Repeatable

Information about a student’s affiliation with other organizations for the current school year.

OrganizationAffiliation/ SchoolId

Required The department assigned number of the affiliated organization. Note: Student cannot be affiliated with their own School Division.

of 91


HomeRoom Optional Required for students enrolling in Grades preK – 9.

HomeRoom/Educator Certificate Number

Required The educator certificate number of the educator who presides over the student’s home room. Must be a valid 7-digit educator certificate number.

HomeRoom/HomeRoom Identifier

Optional 25 character alphanumeric field. Default to Educator Last name and first initial of first name, if not included in object.

Relationship of Student to School (Membership Type) ValuesBase Base school (default if not specified)Other Other school

Enrollment Type Codes (and when to use them)01 Transfer from another Saskatchewan school (No longer used)03 Transfer from out-of-province schooling within Canada04 Transfer from another Saskatchewan school (Public, Separate,

Historical, Independent, Custody and Care)05 Transfer from a First Nation school in Saskatchewan10 Transfer from out-of-country schooling13 Transfer from home-based in Saskatchewan15 Continuation of enrollment at the same school (this student already

has an active enrollment record at this school in The Ministry of Education’s database)

16 Readmission (student has already completed grade 12, or student voluntarily discontinued or was expelled from his/her previous school)

18 New (no previous schooling anywhere)50 Exchange student99 Not base school

Grade Codes – a warning message will be included in the XML Response file where the date of birth and the grade are inconsistentP3 Pre-kindergarten (age group of 2 ½ to 3 ½ year olds) (No Longer Available)PK Pre-kindergarten (age group of 2 ½ to 5 year olds)0K Kindergarten (4 – 7 years old)01 Grade 1 (5 – 8 years old)02 Grade 2 (6 – 9 years old)03 Grade 3 (7 – 10 years old)04 Grade 4 (8 – 11 years old)

of 91


05 Grade 5 (9 – 12 years old)06 Grade 6 (10 – 13 years old)07 Grade 7 (11 – 14 years old)08 Grade 8 (12 – 15 years old)09 Grade 9 (13 – 16 years old)10 Grade 10 (14 – 17 years old)11 Grade 11 (15 – 18 years old)12 Grade 12 (16 + years old)

Enrollment Outcome and Discontinuation Reason Codes

01 Transferred to another Saskatchewan school (No longer used)03 Transferred to out-of-province schooling within Canada10 Transferred to out-of-country schooling12 Completed Functional Integrated Program13 Transferred to home-based in Saskatchewan15 Completed schooling17 Deceased18 Discontinued schooling, with a reason of “health reasons”19 Expelled21 Discontinued schooling, with no reason24 Discontinued schooling, with a reason of “other education”25 Discontinued schooling, with a reason of “non-based”50 Discontinued schooling, with a reason of “employment”52 Discontinued schooling, with a reason of “dissatisfied with school”53 Discontinued schooling, with a reason of “other reason”60 Enrollment cancelled/no show61 Discontinued schooling, with a reason of “monitored”

63Transferred to another Saskatchewan school (Public, Separate, Historical, Independent, Custody and Care)

64 Transferred to another First Nation Saskatchewan school

Immersion Type Values (not the same as Program Enrolment)

CR Cree ImmersionUK Ukrainian ImmersionFR French ImmersionNA Not Applicable

Homebound Values

Yes Student is HomeboundNo Student is not Homebound

of 91


Cumulative Folder

Yes School has Cumulative FolderNo School does not have Cumulative Folder

Tuition Status Values

FE Foreign Exchange FT TuitionRE Reciprocal ExchangeLA SK-AB Lloyd AgreementPANA

Other Provincial AgreementNot Applicable

Example<SchoolEnrollmentInfo MembershipType=”Base”>

<EntryDate>2012-09-02</EntryDate><EntryType Code=”01”/><Grade Code=”11”/>

</SchoolEnrollmentInfo>

Example – Note: Student cannot be affiliated with their own School Division

<SchoolEnrollmentInfo MembershipType=”Base”><EntryDate>2012-08-25</EntryDate><EntryType Code=”01”/><Grade Code=”10”/><ImmersionType Code = “CR” /><Homebound Code = “No” /><CumulativeFolder Code = “Yes” /><OrganizationAffiliation>

<SchoolId = 1234567></OrganizationAffiliation>

</SchoolEnrollmentInfo>

2.7 ProgramEnrollmentInfo Element Attribute Status Description/NotesProgramEnrollmentInfo Information about a student’s enrollment in a

programEntryDate Required The effective start date of the program

enrollment

of 91


Example<ProgramEnrollmentInfo>

<EntryDate>2010-09-02</EntryDate></ProgramEnrollmentInfo>

2.8 ClassEnrollmentInfoElement Attribute Status Description/NotesClassEnrollmentInfo Information about a student’s registration in a

classClassInfoOverride Optional Optional overrides for this student

Override Required Whether or not class information has been overridden with different values for this student (see below)

ClassInfoOverride/ ModeOfInstruction

Optional Override indicating how this student receives instruction for this class

Code Required Mode of instruction for this student (see below)MarkSource Optional How the final mark is to be derived for this

student for this class. Defaults if not provided for a new class enrollment (see Appendix B).

Code Required Final mark code (see below)Dropped Optional Whether or not the student has dropped out of

the classCode Required Dropped code (see below)

ExitDate Optional If the student dropped the class, date on which this occurred, if known. Ignored if before StartDate of the class or on or after EndDate of the class.

Override ValuesYes An override exists for this studentNo No override exists for this student

Mode of Instruction ValuesClass Classroom instructionDistance Distance learning

Final Mark Source ValuesBlended Blended school and departmental marks (60% / 40%)School 100% school mark

Dropped ValuesYes The student dropped the classNo The student did not drop the class

of 91


Example<ClassEnrollmentInfo>

<ClassInfoOverride Override=”Yes”><ModeOfInstruction Code=”Distance”/>

</ClassInfoOverride><MarkSource Code=”Blended”/>

</ClassEnrollmentInfo>

2.9 ExamRegistrationInfo Element Attribute Status Description/NotesExamRegistrationInfo Information about a student’s registration to

write a departmental examType Optional The type of exam registration (see below).

Required in object StudentExamRegistration.ExamPeriodEndDate Required The end date of the exam period in which the

student plans to write the examNote: Any date within the exam period will be accepted.

Exam Registration Type ValuesClass With class (default and only valid value in object

StudentClassEnrollment, not allowed in object StudentExamRegistration)

Supplemental Supplemental examAdult Adult challenge

Example<ExamRegistrationInfo Type = “Supplemental” >

<ExamPeriodEndDate>2013-01-27</ExamPeriodEndDate></ExamRegistrationInfo>

2.10 ExamLocation Element Attribute Status Description/NotesExamLocation Identifies a departmental exam writing centreSchoolId Required The department-assigned school number of the school

serving as the writing centre. Note: The writing centre must be any approved writing centre for the given exam period.

Example<ExamLocation >

<SchoolId>3456789</SchoolId></ExamLocation>

of 91


2.11 SchoolMarkInfoThis element provides the student's school mark for a course.

Note that marks can be corrected via XML only for a certain time period after the end of the class or the initial submission of a supplemental mark (rule SDS-MARKS-004). Contact Student Records for the exact time limit.

Element Attribute Status Description/NotesSchoolMarkInfo Information about a mark the school has

assigned a studentCorrectionCode Optional Whether or not this is a correction to a

previously reported mark (see below). Defaults to “No” if not specified.

SchoolMark Required The mark granted by the school. This has to be a whole number between 1 and 100 inclusive (rule DAT-STUREC-033).

Correction CodesYes This is a correction to a previously reported markNo This is not a correction (default if not specified)

Example<SchoolMarkInfo CorrectionCode=”No”>

<SchoolMark>75</SchoolMark></SchoolMarkInfo>

2.12 StudentCourseInfo This Object is included in applicable query response files only and allows the Ministry of Education to return information to a school on request. See Section 3 Queries for how to request this information.

Element Attribute Status Description/NotesStudentCourseInfo Information about a course taken by a student or

for which a student has received credit (e.g., by writing a challenge exam).

Type Required The type of course (see below)SchoolYear Optional The school year the course was considered to be

part of, expressed as both four-digit calendar years that the school year spans with a hyphen between (e.g. "2004-2005")

CourseEndDate Required The date the course is considered to have endedDropped Optional Whether or not the student dropped out of the

course

of 91


Code Required Dropped code (see below)FinalMark Optional The final mark the student was grantedCreditsEarned Required The number of credits this student was granted

for this course

Student Course Type ValuesBlended School and departmental examSchool School onlyDept Departmental exam onlyTransfer Transfer in credit

Dropped ValuesYes The student dropped the courseNo The student did not drop the course

Example<StudentCourseInfo Type=”Blended”>

<SchoolYear>2012-2013</SchoolYear><CourseEndDate>2013-01-28</CourseEndDate><Dropped Code=”No”/><FinalMark>78</FinalMark><CreditsEarned>1.0</CreditsEarned>

</StudentCourseInfo>

2.13 StudentExternalCourseInfoThis Object is included in applicable query response files only and allows the Ministry of Education to return information to a school on request. See Section 3 Queries for how to request this information.

This element provides detail about one external course taken by a student. An external course is one taken outside the provincial system, but to be recognized by the provincial system – e.g., a course transferred in from another province or country or a Driver Education course.

Note that the XML is designed to support both courses submitted electronically and the scannable External Course Evaluation Form.

Element Attribute Status Description/NotesStudentExternalCourseInfo Information about a course taken by a

student outside of the provincial system, which is to be recognized by the provincial system.

DeptAssignedCourseId Required The department-assigned number of the course the student took or the closest

of 91


Saskatchewan equivalent. Note that only certain courses (currently only Driver Education) are accepted in XML sent electronically.

CourseEndDate Required The date the course ended. Cannot be used to change the course end date for an existing external course, because it is used as part of the identification of the course (along with DeptAssignedCourseId).

SchoolId Optional The department-assigned number of the school sending the information. Required for XML sent electronically (rule SDS-MARKS-050).

ProvinceState Optional The Canadian province or territory from which the course is being transferred. For internal use only (for the scannable form). Required if SchoolId is not provided, and not allowed if SchoolId is provided (rule SDS-MARKS-050).

Code Required Canadian province code as used by Canada Post

FinalMark Optional The final mark the student received (if applicable). Required for XML sent electronically (rule SDS-MARKS-050).

2.14 StudentClassThis Object is included in applicable query response files only and allows the Ministry of Education to return information to a school on request. See Section 3 Queries for how to request this information.

This element provides information about one student class registration and the associated department exam registration (if applicable).

Element Attribute Status Description/NotesStudentClass Information about one student class

registration and the associated dept exam registration (if applicable).

ClassId Required Unique identifier of the class within the school and term.

ModeofInstruction RequiredCode Required Mode of instruction for this student (see

below)MarkSource Required

Code Required Final mark code (see below)

of 91


ExamPeriodEndDate Optional The end date of the exam period in which the student plans to write the exam.

ExamLocation Optional Identification of the writing centre for the department exam (if applicable). Note: Included only if the writing centre is different from the school of the class. Element 2.10.

2.15 StudentDeptExamThis Object is included in applicable query response files only and allows the Ministry of Education to return information to a school on request. See Section 3 Queries for how to request this information.

This element provides information about one student registration in a department exam not associated with a class registration (i.e. where the mark is to be 100% department exam).

Element Attribute Status Description/NotesStudentDeptExam Information about one student

registration in a 100% dept exam.DeptAssignedCourseId Required The department-assigned number of the

course whose exam the student plans to write.

ExamRegistrationInfo Required The type and exam period end date. Element 2.9.

ExamLocation Required Identification of the writing centre. Element 2.10.

2.16 CompletedCourseThis Object is included in applicable query response files only and allows the Ministry of Education to return information to a school on request. See Section 3 Queries for how to request this information.

This element provides information about one course a student has completed (whether passed or failed). CourseTitle will be included only if requested in the query. SchoolYear will be included except for credit transfer courses. FinalMark will be included if the course has one (not standing granted).

Element Attribute Status Description/NotesCompletedCourse Information about a course taken by a student

or for which a student has received credit (e.g., by writing a challenge exam).

Type Required The type of course (see below)

of 91


DeptAssignedCourseId Required The department-assigned number of the course the student took.

CourseTitle Optional The name of the course the student took.SchoolYear Optional The school year the course was considered to

be part of, expressed as both four-digit calendar years that the school year spans with a hyphen between (e.g. "2009-2010")

CourseEndDate Required The date the course is considered to have ended

FinalMark Optional The final mark the student was grantedCreditsEarned Required The number of credits this student was

granted for this course

Student Course Type ValuesBlended School and departmental examSchool School onlyDept Departmental exam onlyTransfer Transfer in credit

Example<CompletedCourse Type=”Blended”>


</CompletedCourse>

2.17 DeptCourseThis Object is included in applicable query response files only and allows the Ministry of Education to return information to a school on request. See Section 3 Queries for how to request this information.

This element provides information about one department-defined course.

Element Attribute Status Description/NotesDeptCourse Information about a department-defined

course.DeptAssignedCourseId Required The unique identifying number assigned by

the department to the course.CourseTitle Required The name of the course.Grade Required The grade the course is in.

Code Required Grade code (see grade codes under element 2.5 SchoolEnrollmentInfo).

of 91


CreditValue Optional The number of credits the course is worth if a student passes it.

EffectiveDate Required The date the course first became available for schools to offer.

Example<DeptCourse>

<DeptAssignedCourseId>6211</DeptAssignedCourseId> <CourseTitle>Biology 20</CourseTitle> <Grade Code=”11”/>

<CreditValue>1</CreditValue> <EffectiveDate>1992-08-16</EffectiveDate> </DeptCourse>

3. QueriesQuery allows a school to request certain data. There are a limited number of pre-defined queries that are supported.

3.1 SL_QueryElement Attribute Status Description/NotesSL_QuerySL_QueryObject Required

and Repeatable

The object type that is to be returned

RefId Required The reference ID for returning the response.

ObjectName Required The name of the type of object to be returned (see below)

ScopeCode Optional Data scope code (see below). Applicable only if querying student course history. Defaults to “All” if not specified when querying course history.

SL_QueryObject/ DeptAssignedPersonId

Optional The Learning ID Number of the student whose data is to be returned

SL_QueryObject/ BirthDate

Optional The birth date of the student whose data is to be returned (a double-check that the right student is being queried)

SL_QueryObject/ SchoolId

Optional The department-assigned number of the school whose data is to be returned

SL_QueryObject/ FromDate

Optional The first date of the date range for which data is to be returned (see notes below)

of 91


SL_QueryObject/ ToDate

Optional The last date of the date range for which data is to be returned (see notes below)

Object Names Supported for QueryStudentPersonalStudentCourseHistory

Data Scope CodesThese codes define which courses to return for the students who are included in the query criteria.

All Return all courses for all yearsCurrent Return all courses whose final mark was entered or changed in the Student

Data System within the date range specifiedDept Return all courses whose final mark was entered or changed in the Student

Data System within the date range specified, except courses with a 100% school mark

Note that the latter two scope codes return: courses completed (final mark posted) within the date range final mark corrections made within the date range (for courses completed earlier) transfer in credits entered into the system within the date rangeSome of the courses returned will already be in the school’s database, while some will not (e.g., courses taken elsewhere and transfer in credits).

NotesThe query must include exactly one of the following: the DeptAssignedPersonId and BirthDate of one student the SchoolId, FromDate and ToDate

The former is used to query demographic or course history for one student. The latter is used to query course history for all students enrolled in the indicated school (as the base school or as a non-base school) any time during the date range indicated. Students are not included in the latter query if their only relationship to the school is being registered in a course delivered by the school (it is assumed that these students are not in the school’s database).

When querying course history for one student, the only valid ScopeCode is “All”. When querying course history for all students enrolled during a date range, any of the ScopeCodes can be used.

of 91


ExamplesRequest student demographic information for a student:

<SL_Query><SL_QueryObject RefId=”1” ObjectName=”StudentPersonal”>

<DeptAssignedPersonId>123456789</ DeptAssignedPersonId ><BirthDate>1985-03-15</BirthDate>

</SL_QueryObject></SL_Query>

Request student course history for a student:

<SL_Query><SL_QueryObject RefId=”2” ObjectName=”StudentCourseHistory”

ScopeCode=”All”>< DeptAssignedPersonId >123456789</ DeptAssignedPersonId ><BirthDate>1985-03-15</BirthDate>


Request all student course history for all students enrolled in a school during a particular school year (defined by a date range):


ScopeCode=”All”><SchoolId>1234567</SchoolId><FromDate>2004-08-01</FromDate><ToDate>2005-07-31</ToDate>


Request student course changes entered during the term just ended for all students enrolled in a school in that term:


ScopeCode=”Current”><SchoolId>1234567</SchoolId><FromDate>2004-02-01</FromDate><ToDate>2004-06-28</ToDate>


3.2GeneralQueryThis allows the school to request general information (not specific to either a school or a particular student) such as a list of department courses.

of 91


Element Attribute Status Description/NotesGeneralQuery A request to return information that is

neither specific to a student or a school (e.g., list of department courses).

RefId Required The reference ID for returning the response.

ObjectName Required The name of the type of object to be returned (see below)

Object Names Supported for GeneralQueryDeptCourses

ExampleRequest a current list of dept-defined grade 10-12 courses:

<SL_Query><GeneralQuery RefId=”1” ObjectName=”DeptCourses”></GeneralQuery>

</SL_Query>

3.3QueryByStudentThis allows the school to request information about individual students.

Element Attribute Status Description/NotesQueryByStudent A request to return information for a

specific student.RefId Required The reference ID for returning the

response.ObjectName Required The name of the type of object to be

returned (see below)IncludeLookupNames

Optional Code (see below) to indicate whether or not to include SchoolName, ProgramName and CourseTitle in the returned data. Applicable only if querying objects that optionally include SchoolName, ProgramName and/or CourseTitle. Defaults to “No” if not specified.

DeptAssignedPersonId Optional The Learning ID Number of the student whose data is to be returned

Name Optional Student’s name(s). Either the DeptAssignedPersonId or the Name must be included.

Type Required Name type (see StudentInfo element 2.5)

of 91


Name/LastName Required Last name.

Name/FirstName Required First name.

BirthDate Required The birth date of the student whose data is to be returned (a double-check that the right student is being queried)

Object Names Supported for QueryByStudentStudentPersonal returns demographic data (including Saskatchewan Residency and Resident Type) Allowing the Name and BirthDate combination in place of the DeptAssignedPersonId

and BirthDate combination will allow schools to retrieve the Learning ID, in support of school enrolment.

StudentEnrollment returns all current and previous school enrolments, start and end dates, current

program enrolment, current grade enrolment, cumulative folder indicator, tuition Status, immersion type, homebound, organization affiliation, home room teacher (educator certificate number) home room Identifier, PreKindergarten (Ministry Designated) . The cumulative folder indicator will only be returned if the SDS has cumulative folder location information for the student. The Department Assigned Number for the school that has the cumulative folder will also be returned.

Note: Grade will be blank for any student whose enrollment is not end dated at the requesting school but for whom no current grade enrollment is on record.

StudentCourseEnrollments returns all non-dropped class and department exam registrations at all schools, for

which there is no final markStudentCompletedCourses returns all courses completed by the student

Include Lookup Names CodesYes Include lookup names such as SchoolName, ProgramName and CourseTitleNo Do not include lookup names such as SchoolName, ProgramName and

CourseTitle

ExamplesRequest student demographic information for a student:

<SL_Query><QueryByStudent RefId=”1” ObjectName=”StudentPersonal”>

<DeptAssignedPersonId>123456789</ DeptAssignedPersonId ><BirthDate>1997-03-15</BirthDate>

</QueryByStudent></SL_Query>

of 91


Request student course history for a student:

<SL_Query><QueryByStudent RefId=”2” ObjectName=”StudentCompletedCourses”>

< DeptAssignedPersonId >123456789</ DeptAssignedPersonId ><BirthDate>1997-03-15</BirthDate>

</QueryByStudent></SL_Query>

3.4QueryBySchoolThis allows the school to request information about all students enrolled in a school.

Element Attribute Status Description/NotesQueryBySchool A request to return information for

students enrolled in 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)ScopeCode Optional Data scope code (see below).

Applicable only if querying StudentCourseEnrollments or StudentCompletedCourses. Defaults to “All” if not specified.

IncludeLookupNames Optional Code (see below) to indicate whether or not to include SchoolName, ProgramName and CourseTitle in the returned data. Applicable only if querying objects that optionally include SchoolName, ProgramName and/or CourseTitle. Defaults to “No” if not specified.

SchoolId Required The department-assigned number of the school whose data is to be returned

FromDate Required The first date of the date range for which data is to be returned (see notes below)

ToDate Required The last date of the date range for which data is to be returned (see notes below)

FromGrade Optional The first grade of the grade range for which data is to be returned (see notes below)

Code Required Grade code (same as used in element 2.6 SchoolEnrollmentInfo).

of 91


ToGrade Optional The last grade of the grade range for which data is to be returned (see notes below)

Code Required Grade code (same as used in element 2.6 SchoolEnrollmentInfo).

Object Names Supported for QueryStudentPersonal returns demographic data, including Saskatchewan Residency and Resident TypeStudentEnrollment returns current enrolment in the requesting school only, including program, grade,

organization affiliation, home room teacher, home room identifier, PreKindergarten (Ministry designated), tuition status, immersion, home bound, and cumulative folder flag, if available.

Note: Grade will be blank for any student whose enrollment is not end dated at the requesting school but for whom no current grade enrollment is on record.

StudentCourseEnrollments returns non-dropped class and department exam registrations at all schools, for which

there is no final mark, according to the data scope described belowStudentCompletedCourses returns courses completed by the student, according to the data scope described belowStudentNotReEnrolled returns the students that have been enrolled in the school, but are not now enrolled in

any school and are less than 16 years of age

Data Scope CodesFor StudentCourseEnrollments, these codes define which registrations to return for the students who are included in the query criteria.

All Return all non-dropped courses that are not completeCurrent Return all non-dropped courses that are not completed, whose course end date

falls within the date range specified

For StudentCompletedCourses, these codes define which courses to return for the students who are included in the query criteria.

All Return all completed courses for all yearsCurrent Return all courses whose final mark (or standing granted) was entered or

changed in the Student Data System within the date range specified

Note that the second scope code “Current” returns: courses completed (final mark posted) within the date range final mark corrections made within the date range (for courses completed earlier) transfer in credits entered into the system within the date range

of 91


Some of the courses returned will already be in the school’s database, while some will not (e.g. courses taken elsewhere and transfer in credits).

Include Lookup Names CodesYes Include lookup names such as SchoolName, ProgramName and CourseTitleNo Do not include lookup names such as SchoolName, ProgramName and

CourseTitle

NotesIf a grade range is not specified, this query returns all students enrolled in the indicated school (as the base school or as a non-base school) any time during the date range indicated.

If a grade range is indicated, it returns all students enrolled in the indicated school (as the base school or as a non-base school) any time during the date range indicated, whose most recent grade enrollment is within the grade range indicated.

ExamplesRequest all student course history for all students enrolled in a school during a particular school year (defined by a date range):

<SL_Query><QueryBySchool RefId=”3” ObjectName=”StudentCompletedCourses”

ScopeCode=”All”><SchoolId>1234567</SchoolId><FromDate>2011-08-01</FromDate><ToDate>2012-07-31</ToDate>

</QueryBySchool></SL_Query>

Request student course mark changes entered during the term just ended for all grade 12 students enrolled in a school in that term:

<SL_Query><QueryBySchool RefId=”4” ObjectName=”StudentCompletedCourses”

ScopeCode=”Current”><SchoolId>1234567</SchoolId><FromDate>2011-02-01</FromDate><ToDate>2012-06-28</ToDate><FromGrade Code=”12”/><ToGrade Code=”12”/>


of 91


Request students that are no longer enrolled in the school:

<SL_Query><QueryBySchool RefId="5" ObjectName="StudentNotReEnrolled"

ScopeCode="Current"><SchoolId>1234567</SchoolId><FromDate>2011-08-01</FromDate><ToDate>2012-07-31</ToDate>


4. Message InfrastructureInformation 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 SL_Message. Within this tag is another tag identifying the type of message:

SL_EventSL_RequestSL_ResponseSL_Ping

4.1 SL_MessageThe outermost tag on all messages.

Element Attribute Status Description/NotesSL_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 3.0). Defaults to 3.0 if not specified.

XML Namespace and Related ValuesFor this release of the The Ministry of Education K-12 XML specifications, use:

xmlns=”http://www.k12.gov.sk.ca/xsd/sl/3.x/SLMessage.xsd”xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.k12.gov.sk.ca/xsd/sl/3.x/SLMessage.xsd http://www.k12.gov.sk.ca/xsd/sl/3.x/SLMessage.xsd"

of 91


Example<SL_Message xmlns=”http://www.k12.gov.sk.ca/xsd/sl/3.x/SLMessage.xsd”

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.k12.gov.sk.ca/xsd/sl/3.x/SLMessage.xsd http://www.k12.gov.sk.ca/xsd/sl/3.x/SLMessage.xsd">Message content goes here

</SL_Message>

4.2 SL_HeaderWithin each type of message is SL_Header, which identifies the message and when it was sent.

Element Attribute Status Description/NotesSL_HeaderSL_MsgId Required A unique identifier of the message (see note below)SL_Date Required The date the message was sentSL_Time Required The time at which the message was sent, in format

HH:MM:SS, using a 24-hour clockZone 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.

SL_SourceId Required The unique ID of the originator of the message. This is the department-assigned number of the organization.

NoteSL_MsgId has to be unique on every message sent between schools and The Ministry of Education. The Ministry of Education cannot accept two XML messages with the same SL_MsgId, even if they come from different schools. SL_MsgId can be any length, as long as it is unique.

Two techniques to ensure uniqueness are recommended. Schools can pick from either of these techniques: Concatenate department-assigned school number, date/time, message sequence

number and user id to create a unique SL_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: {School 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 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, a GUID can be generated as follows:

of 91


select sys_guid() from dual

Note: If a transmission problem prevented The Ministry of Education from receiving an entire batch XML message and the message is being sent again, the SL_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 SL_MsgId should be used for the corrected message.

Example<SL_Header>

<SL_MsgId>12345678901234567890123456789012</SL_MsgId><SL_Date>2012-09-23</SL_Date><SL_Time Zone="UTC-06:00">20:23:54</SL_Time><SL_SourceId>8888888</SL_SourceId>

</SL_Header>

4.3 SL_UserCredentials – removed from specificationThis element is no longer part of the XML specifications.

4.4 SL_EventAn event message indicates that data is to be added or changed.

Element Attribute Status Description/NotesSL_EventSL_Header Required See SL_Header aboveSL_ObjectData Required Wrapper for the data being sent

SL_ObjectData/ SL_EventObject


Identifies the type of object being sent and wraps the data

ObjectName Required The name of the object being sentAction Required The action this event conveys (see

below)Reason Optional The reason that indicates why this data

is being sent, if non-routine (see below)SL_ObjectData/ SL_EventObject/ objectname


The actual data being sent (see object specifications above)

Event Action ValuesAddChangeDelete Delete this information because it was previously sent in error and is incorrect,

or so that it can be replaced from scratch. Must be accompanied by a Reason of “ClericalError” or “ToAllowReplacement”. Valid only for objects StudentSchoolEnrollment, StudentClassEnrollment and

of 91


AllStudentClassEnrollments.

Event Reason ValuesClericalError Valid only for an Action of “Delete” – indicates that the

information originally sent was incorrect and should be deleted.ToAllowReplacement Valid only for an Action of “Delete” – indicates that the

information is to be deleted so that it can be replaced from scratch. For use with object AllStudentClassEnrollments.

ExamplesChange a student’s phone number

<SL_Message xmlns=”http://www.k12.gov.sk.ca/xsd/sl/3.x/SLMessage.xsd”xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.k12.gov.sk.ca/xsd/sl/3.x/SLMessage.xsd http://www.k12.gov.sk.ca/xsd/sl/3.x/SLMessage.xsd">

<SL_Event><SL_Header>


</SL_Header><SL_ObjectData>

<SL_EventObject ObjectName="StudentPersonal" Action="Change"><StudentPersonal RefId="1">

<StudentIdentification> <DeptAssignedPersonId>123456789</DeptAssignedPersonId>

<BirthDate>1996-10-31</BirthDate> </StudentIdentification><StudentInfo>

<PhoneNumber Format="NA" Type="Home">(306) 123-4567

</PhoneNumber></StudentInfo>

</StudentPersonal></SL_EventObject>

</SL_ObjectData></SL_Event>

</SL_Message>

of 91


4.5 SL_RequestA request message asks for data to be returned.

Element Attribute Status Description/NotesSL_RequestSL_Header Required See SL_Header aboveSL_Query Required The query for data. See SL_Query

under Queries.SL_Query/ objectname


The actual queries, which can be any query in section 3.

Example<SL_Message xmlns=”http://www.k12.gov.sk.ca/xsd/sl/3.x/SLMessage_v3.xsd”

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.k12.gov.sk.ca/xsd/sl/3.x/SLMessage_V3.xsd http://www.k12.gov.sk.ca/xsd/sl/3.x/SLMessage_V3.xsd">

<SL_Request><SL_Header>


</SL_Header><SL_Query>

<GeneralQuery RefId=”1” ObjectName=”DeptCourses”></GeneralQuery>

</SL_Query></SL_Request>

</SL_Message>

4.6 SL_ResponseA 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/NotesSL_ResponseSL_Header Required See SL_Header aboveSL_Ack Required Acknowledgement of the message that

elicited this responseSL_Ack/ SL_OriginalMsgId

Required The message ID of the message that elicited this response

SL_Ack/ SL_OriginalSource Id

Required The unique ID of the originator of the message that elicited this response

SL_Ack/SL_Status Required Whether or not the original message was successfully processed

of 91


SL_Ack/SL_Status/ SL_StatusCode

Required Status code (see below)

SL_Ack/SL_Status/ SL_StatusMsg

Optional Message if required to clarify the status

SL_Ack/SL_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

SL_Ack/SL_Error/ SL_ErrorSeverity

Required Message severity (see below)

SL_Ack/SL_Error/ SL_ErrorCode

Required Error code (values published separately)

SL_Ack/SL_Error/ SL_ErrorMsg

Optional Message describing the error

SL_ObjectData Optional Wrapper for any data being returnedSL_ObjectData/ SL_EventObject


Identifies the type of object being returned and wraps the data

ObjectName Required The name of the object being returnedAction Required Will be set to “None”Reason Optional Not applicable

SL_ObjectData/ SL_EventObject/ objectname


The actual data being returned (see object specifications above)

Status Code ValuesSuccessful Processed successfully, no messages or only informational messagesWarnings Processed successfully with warning messagesErrors Processed with error messagesInvalid Invalid XML

Message Severity ValuesInformationalWarningError

ExamplesResponse to an event updating a student’s address

<SL_Message xmlns=”http://www.k12.gov.sk.ca/xsd/sl/3.x/SLMessage.xsd”xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

of 91


xsi:schemaLocation="http://www.k12.gov.sk.ca/xsd/sl/3.x/SLMessage.xsd http://www.k12.gov.sk.ca/xsd/sl/3.x/SLMessage.xsd">

<SL_Response><SL_Header>


</SL_Header><SL_Ack>

<SL_OriginalMsgId>98765432109876543210987654321098</SL_OriginalMsgId>

<SL_OriginalSourceId>1234567</SL_OriginalSourceId><SL_Status>

<SL_StatusCode>01</SL_StatusCode><SL_StatusMsg>Successful</SL_StatusMsg>

</SL_Status><SL_Error ObjectName=”StudentSchoolEnrollment“ RefId=”1“>

<SL_ErrorSeverity>Informational</SL_ErrorSeverity><SL_ErrorCode>05</SL_ErrorCode><SL_ErrorMsg>

Address start date defaulted to 2012-09-16</SL_ErrorMsg>

</SL_Error></SL_Ack>

</SL_Response></SL_Message>

Response to a request for a student’s course history

<SL_Message xmlns=”http://www.k12.gov.sk.ca/xsd/sl/3.x/SLMessage.xsd”xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.k12.gov.sk.ca/xsd/sl/3.x/SLMessage.xsd http://www.k12.gov.sk.ca/xsd/sl/3.x/SLMessage.xsd">

<SL_Response><SL_Header>


</SL_Header><SL_Ack>

<SL_OriginalMsgId>98765432109876543210987654321098</SL_OriginalMsgId>

<SL_OriginalSourceId>1234567</SL_OriginalSourceId><SL_Status>

<SL_StatusCode>01</SL_StatusCode>

of 91


<SL_StatusMsg>Successful</SL_StatusMsg></SL_Status>

</SL_Ack><SL_ObjectData>

<SL_EventObject ObjectName="StudentCompletedCourses" Action="None">

<StudentCompletedCourses RefId = “1”><StudentIdentification>

<DeptAssignedPersonId>123456789</DeptAssignedPersonId> <BirthDate>1996-10-31</BirthDate>

</StudentIdentification><CompletedSchoolCourses>



</CompletedCourse><CompletedCourse Type=”School”>


</CompletedCourse></CompletedSchoolCourses>

</StudentCompletedCourses></SL_EventObject>

</SL_ObjectData></SL_Response>

</SL_Message>

4.7 SL_PingThe ping message allows an institution to determine whether the system it wants to send messages to is receiving messages.

Element Attribute Status Description/NotesSL_Ping Required Request to acknowledge the pingSL_Header Required See SL_Header above

Example<SL_Message xmlns=”http://www.k12.gov.sk.ca/xsd/sl/3.x/SLMessage.xsd”

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

of 91


xsi:schemaLocation="http://www.k12.gov.sk.ca/xsd/sl/3.x/SLMessage.xsd http://www.k12.gov.sk.ca/xsd/sl/3.x/SLMessage.xsd">

<SL_Ping><SL_Header>


</SL_Header></SL_Ping>

</SL_Message>

of 91


Appendix A – Country, Language and Province/State Codes

Country Codes (source: ISO-3166-1)AF Afghanistan AX Aland IslandsAL Albania DZ Algeria AS American Samoa AD Andorra AO Angola AI Anguilla AQ Antarctica AG Antigua and Barbuda AR Argentina AM Armenia AW Aruba AU Australia AT Austria AZ AzerbaijanBS Bahamas BH Bahrain BD Bangladesh BB Barbados BY Belarus BE Belgium BZ Belize BJ Benin BM Bermuda BT Bhutan BO BQ

Bolivia, Plurinational State of Bonaire, SINT Eustatius and Saba

BA Bosnia And Herzegovina BW Botswana BV Bouvet Island BR Brazil IO British Indian Ocean Territory BN Brunei Darussalam BG Bulgaria BF Burkina Faso BU Burma (No Longer Exists, see Myanmar) BI Burundi KH Cambodia CM Cameroon CA Canada CV Cape Verde KY Cayman Islands

of 91


CF Central African Republic TD Chad CL Chile CN China CX Christmas Island CC Cocos (Keeling) Islands CO Colombia KM Comoros CG Congo CD Congo, The Democratic Republic Of The CK Cook Islands CR Costa Rica CI Côte D’ivoire (Ivory Coast)HR Croatia CUCW

CubaCuracao

CY Cyprus CZ Czech Republic CS Czechoslovakia (No Longer Exists) YD Democratic Yemen (No Longer Exists) DK Denmark DJ Djibouti DM Dominica DO Dominican Republic EC Ecuador EG Egypt SV El Salvador GQ Equatorial GuineaER Eritrea EE Estonia ET Ethiopia FK Falkland Islands (Malvinas) FO Faroe Islands FJ Fiji FI Finland FR France GF French Guiana PF French Polynesia TF French Southern Territories GA Gabon GM Gambia GE Georgia DD German Democratic Republic (No Longer Exists) DE Germany GH Ghana GI Gibraltar

of 91


GR Greece GL Greenland GD Grenada GP GuadeloupeGU Guam GT Guatemala GG GuernseyGN GuineaGW Guinea-Bissau GY Guyana HT Haiti HM Heard Island and McDonald Islands HN Honduras HK Hong Kong HU Hungary IS Iceland IN India ID Indonesia IR Iran, Islamic Republic ofIQ Iraq IE IrelandIM Isle of ManIL Israel IT Italy JM Jamaica JP Japan JE JerseyJO Jordan KZ Kazakhstan KE Kenya KI Kiribati KP Korea, Democratic People’s Republic Of KR Korea, Republic Of KW Kuwait KG Kyrgyzstan LA Lao People’s Democratic Republic LV Latvia LB Lebanon LS Lesotho LR Liberia LY Libya LI Liechtenstein LT Lithuania LU Luxembourg MO Macao MK Macedonia, the Former Yugoslav Republic Of

of 91


MG Madagascar MW Malawi MY Malaysia MV Maldives ML Mali MT Malta MH Marshall Islands MQ Martinique MR Mauritania MU Mauritius YT Mayotte MX Mexico FM Micronesia, Federated States of MD Moldova, Republic Of MC Monaco MN MongoliaME MontenegroMS Montserrat MA Morocco MZ Mozambique MM Myanmar NA Namibia NR Nauru NP Nepal NL Netherlands AN Netherlands Antilles (No Longer Exists)NT Neutral Zone (No Longer Exists) NC New Caledonia NZ New Zealand NI Nicaragua NE Niger NG Nigeria NU Niue NF Norfolk Island MP Northern Mariana Islands NO Norway OM Oman PK Pakistan PW Palau PS Palestinian Territory, OccupiedPA Panama PG Papua New Guinea PY Paraguay PE Peru PH Philippines PN Pitcairn

of 91


PL Poland PT Portugal PR Puerto Rico QA Qatar RE Réunion RO Romania RU Russian Federation RW Rwanda BL Saint BarthélemySH Saint Helena, Ascension and Tristan Da CunhaKN Saint Kitts and NevisLC Saint Lucia MF Saint Martin (French Part)PM Saint Pierre and MiquelonVC Saint Vincent and the GrenadinesWS Samoa SM San Marino ST Sao Tome and Principe SA Saudi Arabia SN Senegal RS Serbia, Republic ofSC Seychelles SL Sierra Leone SG SX

Singapore Sint Maarten (Dutch Part)

SK Slovakia SI Slovenia SB Solomon Islands SO Somalia ZA South Africa GSSS

South Georgia And The South Sandwich Islands South Sudan

ES Spain LK Sri Lanka SD Sudan SR Suriname SJ Svalbard and Jan Mayen Islands SZ Swaziland SE Sweden CH Switzerland SY Syrian Arab Republic TW Taiwan, Province Of China TJ Tajikistan TZ Tanzania, United Republic Of TH Thailand TP Timor-Leste

of 91


TG Togo TK Tokelau TO Tonga TT Trinidad and Tobago TN Tunisia TR Turkey TM Turkmenistan TC Turks and Caicos Islands TV Tuvalu UG Uganda UA Ukraine SU Union Of Soviet Socialist Republics (No Longer Exists) AE United Arab Emirates GB United Kingdom (Great Britain) UM United States Minor Outlying Islands US United States Of America ZZ Unknown Or Unspecified Country UY Uruguay UZ Uzbekistan VU Vanuatu VA Vatican City State VE Venezuela, Bolivarian Republic of VN Viet Nam VG Virgin Islands, British VI Virgin Islands, U.S. WF Wallis and Futuna Islands EH Western Sahara YE Yemen RepublicYU Yugoslavia (No Longer Exists)ZM Zambia ZW Zimbabwe

Language Codes (source: ISO-639-2)The list does not have separate codes for all languages 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 AbkhazianACE AchineseACH Acoli ADA Adangme ADY AdygheAAR AfarAFH Afrihili (Artificial language) AFR Afrikaans AFA Afro-Asiatic Languages

of 91


AIN AinuAKA AkanAKK Akkadian ALB Albanian ALE Aleut languagesALG Algonquian languages AJM Aljamia TUT Altaic Languages AMH Amharic ANP AngikaAPA Apache languages ARA Arabic ARG AragoneseARC Official Aramaic ARP Arapaho ARW Arawak ARM Armenian RUP Aromanian; Macedo-RomanianART Artificial Languages ASM Assamese AST Asturian; BableATH Athabascan languages AUS Australian languagesMAP Austronesian Languages AVA Avaric AVE Avestan AWA Awadhi AYM Aymara AZE Azerbaijani NAH Aztec BAN Balinese BAT Baltic LanguagesBAL Baluchi BAM Bambara BAI Bamileke languages BAD Banda languagesBNT Bantu languagesBAS Basa BAK Bashkir BAQ Basque BTK Batak languagesBEJ Beja BEL BelarusianBEM Bemba BEN Bengali BER Berber languages

of 91


BHO Bhojpuri BIH Bihari LanguagesBIK Bikol BIN Bini BIS BislamaBYN BlinBOS BosnianBRA Braj BRE Breton BUG Buginese BUL Bulgarian BUA BuriatBUR Burmese BEL Byelorussian CAD Caddo CAT Catalan CAU Caucasian Languages CEB Cebuano CEL Celtic languages CAI Central American Indian LanguagesKHM Central Khmer CHG Chagatai CMC Chamic LanguagesCHA Chamorro CHE Chechen CHR Cherokee CHY Cheyenne CHB Chibcha NYA Chichewa; NyanjaYUE Chinese, CantoneseCHI Chinese, MandarinCHN Chinook jargon CHP ChipewyanCHO Choctaw CHU Church Slavic CHK ChuukeseCHV Chuvash NWC Classical NewariSYR Classical Syriac COP Coptic COR Cornish COS CorsicanCRE Cree MUS Creek CRP Creoles and Pidgins CPE Creoles and Pidgins, English-based

of 91


CPF Creoles and Pidgins, French-basedCPP Creoles and Pidgins, Portuguese-based CRH Crimean TatarSCRHRV

Croatian (No Longer Available – see HRV)Croatian

CUS Cushitic LanguagesCZE Czech DAK Dakota DAN Danish DAR DargwaDEL Delaware CHP Dene Suline DIN Dinka DIV Divehi; MaldivianDOI Dogri DGR DogribDRA Dravidian Language DUA Duala DUT Dutch DUM Dutch, Middle (ca. 1050-1350) DYU Dyula DZO DzongkhaEFI Efik EGY Egyptian EKA Ekajuk ELX Elamite ENG English ENM English, Middle (1100-1500) ANG English, Old (ca. 450-1100) MYV ErzyaESP Esperanto EST Estonian ETH Ethiopic EWE Ewe EWO Ewondo FAN Fang FAT Fanti FAR Faroese PER FarsiFIJ Fijian FIL Filipino; PilipinoFIN Finnish FIU Finno-Ugrian languages VLA Flemish FON Fon FRE French

of 91


FRM French, Middle (ca. 1400-1600) FRO French, Old (ca. 842-1400) FRI Frisian FRS Frisian, EasternFRR Frisian, NorthernFRY Frisian. WesternFUR FriulianFUL Fulah GAA GaGAE Gaelic, Scots CAR Galibi Carib GAG Galician LUG Ganda GAY Gayo GBA GbayaGEZ GeezGEO 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 GorontaloGOT Gothic GRB Grebo GRC Greek, Ancient (to 1453) GRE Greek, Modern (1453- ) GUA Guarani GUJ Gujarati GWI Gwich’inHAI Haida HAT HaitianHAU Hausa HAW Hawaiian HEB Hebrew HER Herero HIL Hiligaynon HIM Himachali LanguagesHIN Hindi HMO Hiri Motu HUN Hungarian HUP Hupa IBA Iban ICE Icelandic IDO Ido

of 91


IBO Igbo IJO Ijo languagesILO Iloko INC Indic Languages INE Indo-European LanguagesIND Indonesian INH IngushINT Interlingua (International Auxiliary Language Association) ILE InterlingueINU Inuit languagesIKU Inuktitut;InuktutIPK InupiaqIRA 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 KabardianKAB Kabyle KAC Kachin; Jingpho KAL KalaallisutXAL Kalmyk; OiratKAM Kamba KAN Kannada KAU Kanuri KRC Karachay-BalkarKAA Kara-Kalpak KRL KarelianKAR Karen languagesKAS Kashmiri CSB KashubianKAW Kawi KAZ Kazakh KHA Khasi KHI Khoisan Language KHO Khotanese; SakanKIK Kikuyu KMB KimbunduKIN Kinyarwanda KIR Kirghiz; Kyrgyz TLH Klingon; Tlhlngan-Hol

of 91


KOM KomiKON Kongo KOK Konkani KOR Korean KOS KosraeanKPE Kpelle KRO Kru languagesKUA Kuanyama KUM KumykKUR Kurdish KRU Kurukh KUS Kusaie KUT Kutenai LAD Ladino LAH Lahnda LKT LakotaLAM Lamba DAY Land Dayak languagesLAN Langue d’oc (post-1500) LAO Lao LAP Lapp LAT Latin LAV Latvian LTZ Letzeburgesch; LuxembourgishLEZ LezghianLIM LimburganLIN Lingala LIT Lithuanian JBO LojbanNDS Low German; Low SaxonLOZ Lozi LUB Luba-Katanga LUA Luba-LuluaLUI Luiseno LUN Lunda LUO Luo (Kenya and Tanzania) LUS LushaiMAC Macedonian MAD Madurese MAG Magahi MAI Maithili MAK Makasar MLA Malagasy MAY Malay MAL Malayalam MLT Maltese

of 91


MNC ManchuMDR MandarMAN Mandingo MNI Manipuri MNO Manobo languages MAX Manx MAO Maori ARN Mapudungun; Mapuche (was Araucanian) MAR Marathi CHM MariMAH Marshallese MWR Marwari MAS Masai MYN Mayan languages MEN Mende MCH MichifMIC Micmac; Mi’kmaq MIN Minangkabau MWL MirandeseMIS Miscellaneous (Other) (No longer available see Uncoded

Languages)MOH Mohawk MDF MokshaMOLRUM

Moldavian (No longer available)Moldavian

LOL Mongo MON Mongolian MKH Mon-Khmer Languages MOS Mossi MUL Multiple languages MUN Munda (Other) NQO N’KoNAH Nahuatl languagesDAK NakotaNAU NauruNAV Navajo NDE Ndebele, NorthNBL Ndebele, SouthNDO Ndonga NAP NeapolitanNEP Nepali NEW Newari NIA NiasNIC Niger-Kordofanian Languages SSA Nilo-Saharan LanguagesNIU Niuean

of 91


NOG NogaiNON Norse, OldNAI North American Indian Languages NSO Northern Sotho; Pedi NOR Norwegian NOB Norwegian, BokmalNNO Norwegian, NynorskNUB 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; OsseticOTO Otomian languages PAL Pahlavi PAU Palauan PLI Pali PAM Pampanga PAG Pangasinan PAN Panjabi PAP Papiamento PAA Papuan Languages PUS PashtoPER Persian PEO Persian, Old (ca.600-400 B.C.)PHI Philippine LanguagesPHN PhoenicianPON PohnpeianPOL Polish PON Ponape POR Portuguese PRA Prakrit languages PRO Provencal, Old (to 1500) PUS PushtoQUE Quechua RAJ Rajasthani RAP RapanuiRAR Rarotongan; Cook Islands Maori ROA Romance Languages

of 91


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, InariSMJ Sami, LuleSME Sami, NorthernSMS Sami, SkoltSMA Sami, SouthernSAO Samoan SAD Sandawe SAG Sango SAN Sanskrit SAT SantaliSRD SardinianSAS SasakSAU SaulteauxSCO Scots SEL Selkup SEM Semitic Languages SCC Serbian (No Longer Available – use SRP)SRPSRR

SerbianSerer

SHN Shan SHO Shona III Sichuan YiSCN SicilianSID Sidamo SGN Sign LanguagesBLA Siksika (Blackfoot) SND Sindhi SNH Sinhalese SIT Sino-Tibetan SIO Siouan languages SIO Sioux DEN Slave, AthapascanSLA Slavic (Other) SLO Slovak SLV Slovenian SOG SogdianSOM Somali SON Songhai languages

of 91


SNK SoninkeWEN Sorbian languages DSB Sorbian, LowerHSB Sorbian, UpperSSO Sotho SAI South American Indian LanguagesALT Southern AltaiSPA Spanish SRN Sranan TongoSUK Sukuma SUX Sumerian SUN Sundanese SUS Susu SWA Swahili SSW SwatiSWZ Swazi SWE SwedishGSW Swiss GermanTAG Tagalog TAH Tahitian TAI Tai languagesTAJ Tajik TMH TamashekTAM Tamil TAR Tatar TEL Telugu TER Tereno TET TetumTHA Thai TIB Tibetan TIG Tigre TIR Tigrinya TEM Time TIV TivTLI Tlingit TPI Tok PisinTKL TokelauTOG Tonga, Nyasa TON Tonga, Tonga Islands TRU Truk TSI Tsimshian TSO Tsonga TSW Tswana TUM Tumbuka TUP Tupi languagesTUR Turkish

of 91


OTA Turkish, Ottoman TUK Turkmen TVL TuvaluTYV TuvinianTWI Twi UDM UdmurtUGA Ugaritic UIG Uighur UKR Ukrainian UMB MIS

Umbundu Uncoded Languages

UND Undetermined URD Urdu UZB Uzbek VAI Vai VEN Venda VIE Vietnamese VOL VolapukVOT Votic WAK Wakashan languages WAL WalaittaWLN WalloonWAR Waray WAS Washo WEL WAL

Welsh Wolaitta; Wolaytta

WOL Wolof XHO Xhosa SAH YakutYAO Yao YAP Yapese YID Yiddish YOR Yoruba YPK Yupik languagesZND Zande languagesZAP Zapotec ZZA Zaza; DimiliZEN Zenaga ZHA ZhuangZUL Zulu ZUN Zuni

Province/State CodesAB Alberta BC British Columbia MB Manitoba

of 91


NB New Brunswick NL Newfoundland and LabradorNT Northwest Territories NS Nova Scotia NU NunavutON Ontario PE Prince Edward Island QC Quebec SK Saskatchewan YT Yukon AL Alabama AK Alaska AZ Arizona AR Arkansas CA California CO Colorado CT Connecticut DE Delaware DC District of Columbia FL Florida GA Georgia GU Guam HI Hawaii ID Idaho IL Illinois IN Indiana IA Iowa KS Kansas KY Kentucky LA Louisiana ME Maine MD Maryland MA Massachusetts MI Michigan MN Minnesota MS Mississippi MO Missouri MT Montana NE Nebraska NV Nevada NH New Hampshire NJ New Jersey NM New Mexico NY New York NC North Carolina ND North Dakota

of 91


OH Ohio OK Oklahoma OR Oregon PA Pennsylvania PR Puerto Rico RI Rhode Island SC South Carolina SD South Dakota TN Tennessee TX Texas UT Utah VT Vermont VA Virginia VI Virgin Islands WA Washington WV West Virginia WI Wisconsin WY Wyoming

of 91


Appendix B – Additional Edits

Additional Edits Revision HistoryDate Version Changes2003 Oct 24 Pre-release Added minimal XML to register a student in a supplemental

or adult challenge departmental exam.Added rules for rejecting the following: StudentPersonal or StudentProgramEnrollment for an

individual who is not enrolled in the sending school or registered in a class at the sending school (unless accompanied by enrollment or registration).

StudentSchoolMark for a class in which the student is not registered.

Added rules for queries – the system will not return data if the learning id number does not correspond to a student at the sending school.Changed references to PreviousProvince and PreviousCountry to indicate that these have been moved to object StudentSchoolEnrollment.Added edits on StartDates and EndDates.

2003 Oct 29 Pre-release Address edit rules for atomic (discrete) addresses changed2003 Oct 31 Pre-release Added edits on SectionInfo, preventing multiple secondary

level courses per class.2003 Oct 31 Release 1.0 Released.2003 Nov 7 Release 1.0 Correction: StaffPersonal object is not mandatory when

registering a student in a class.Clarification: School mark will not be accepted for a student if the student registration XML does not identify the teacher of the class, unless the class was previously created with a teacher identified.Edit added: If StudentSchoolMark received for a class and the teacher has never been identified for the class, the mark will be rejected.

2003 Nov 17 Release 1.0 Edits added: StudentSectionEnrollment: 2 edits about ExitDate

(dropped date) SectionInfo: rejected if for inactive course number Future-dated TreatyStatusNbr, BandAffiliation or

ReserveResidency will be ignored.2003 Nov 24 Release 1.0 Minimal XML for updating student demographics added.2003 Dec 3 Release 1.1 Modified to match changes in XML for release 1.1.

Some edits moved to main definition of specifications.2003 Dec 4 Release 1.1 Edit added: Reject mark if one exists and this is not a

correction.

of 91


2004 Jan 15 Release 1.1 One error and two warning messages added for StudentSchoolEnrollment (student already in course; student already has credit; missing pre/co-requisite).

2004 Jan 22 Release 1.1 Error added for StudentClassMark (reject if student not enrolled in base school or registered as a home-based student).

2004 Jan 29 Release 1.1 Edit changed – Grade is required for enrollment of a new student. Grade will not be changed if enrollment of existing student does not specify the grade (quick enrollment).

2004 Feb 26 Release 1.1 Edit added – Class mark will be rejected if the MarkSource is School and there is a department exam and the educator is not accredited.Edit added to this section (was already in the main specifications) – Class mark will be rejected if there is no educator assigned to the class.Warning message added – If class is updated to indicate a non-accredited educator and there are registrations that require an accredited educator (marks will be rejected).Warning message added – If class registration received that requires an accredited educator and the educator is not accredited (marks will be rejected).

2005 May 11 Release 1.1 Edit added – Enrollment type of “continuation of enrollment at the same school” is valid only if the student has an active enrollment at the sending school.

of 91


The following rules indicate edits Student Data System XML will be subjected to in addition to any editing listed in the XML specifications, and the system action in each case. Appropriate messages will be returned to the school (to indicate both the cause of the problem and the action taken by the system).

SchoolId

XML Message/system actionSchoolId does not match the message SourceId.

The object containing the SchoolId element will be rejected. Schools can only send data on their own behalf (rule SEC-XML-001).

SchoolClass

XML Message/system actionSchoolClass to update EducatorInfo received and registrations with MarkSource of 100% school mark already exist for the class and the new teacher is not accredited and the course has a department exam.

School mark will not be accepted for any students registered in the class with a MarkSource of 100% school mark (rule SDS-MARKS-012).

StudentSchoolEnrollment

XML Message/system actionStudentSchoolEnrollment received for student not already in The Ministry of Education database and Grade is missing.

StudentSchoolEnrollment will be rejected (rule SDS-ENROL-001).

StudentSchoolEnrollment with action Add received for existing student and Grade is missing.

Student will be kept at same grade as already indicated in the database (rule SDS-ENROL-001).

StudentSchoolEnrollment received indicating “continuation of enrollment at the same school” and the student is not actively enrolled in the school sending the data.

StudentSchoolEnrollment will be rejected (rule SDS-ENROL-012).

StudentSchoolEnrollment received indicating base school and student is already enrolled in a different school as his/her base school.

Enrollment will be treated as a non-base school (rule DAT-LE-041). Message will suggest that school contact the student’s current base school to resolve enrollment status.

StudentSchoolEnrollment received for Grade 10, 11 or 12 student without ProgramEnrollmentInfo or StudentProgramEnrollment and there is no information already on file about what program the student is in.

No profile or transcript can be produced until the student’s program is provided (rule SDS-RPT-001).

of 91


StudentSchoolEnrollment with action Add received, EntryType indicates transfer from out-of-province Canadian schooling and PreviousProvState is missing.

Message will request that previous province be provided (rule DAT-STUREC-008).

StudentSchoolEnrollment with action Add received, EntryType indicates transfer from out-of-country schooling and PreviousCountry is missing.

Message will request that previous country be provided (rule DAT-STUREC-008).

ExitType is not consistent with new enrollment information received from another school.

Enrollment outcome will be updated to reflect new information received (e.g., “discontinued schooling” updated to “transferred to another SK school”) (rule DAT-STUREC-031).

StudentSchoolEnrollment received with action of Delete and this is the student’s base school and the student has course registrations in effect during the time of the enrollment.

Deleting StudentSchoolEnrollment will be rejected (rule SDS-ENROL-003).

StudentClassEnrollment

XML Message/system actionStudentClassEnrollment received for a Class with no educator identified.

School mark will not be accepted for this student for this class (rule SDS-MARKS-002).

StudentClassEnrollment with action Add received and MarkSource is missing.

If the course has a department exam and ExamRegistrationInfo is included or the teacher is not accredited, the final mark will be calculated as a blended school/dept mark. Otherwise, the final mark will be calculated as 100% school mark (rule DAT-STUREC-005).

ExamRegistrationInfo is included but there is no department exam in the course.

ExamRegistrationInfo will be ignored (rule DAT-STUREC-035).

MarkSource indicates School and ExamRegistrationInfo is included and there is a department exam in the course.

MarkSource will be ignored (Blended will be used instead) (rule DAT-STUREC-005).

MarkSource indicates School and ExamRegistrationInfo is not included and there is a department exam in the course and the educator identified for the class is not accredited.

School mark will not be accepted for this student for this class (rule SDS-MARKS-012).

ExitDate is set (to before the term EndDate) and Dropped element is included, and the Dropped element indicates that the student has not dropped the class.

Dropped element will be ignored. It will be assumed that the student dropped the class on the indicated ExitDate (rule DAT-STUREC-018).

of 91


StudentClassEnrollment received with action of Delete and a mark exists for this record.

Deleting StudentClassEnrollment will be rejected (rule DAT-STUREC-010).

StudentClassEnrollment received and the student already has an active registration for the same course during the same term.

StudentClassEnrollment will be rejected (rule SDS-MARKS-007).

StudentClassEnrollment received and the student already has credit for the same course or a “like” credit course, or is currently registered in a “like” credit course.

StudentClassEnrollment will be processed. Message will indicate the existence of the same or like credit course and that the student will not receive credit for both (rule DAT-STUREC-036).

StudentClassEnrollment received and student does not have the pre and/or co-requisites.

StudentClassEnrollment will be processed. Message will indicate missing pre/co-requisite (rule DAT-STUREC-037).

StudentClassMark

XML Message/system actionStudentClassMark received with no CorrectionCode or CorrectionCode=”No” and the student already has a mark for the indicated class.

StudentClassMark will be rejected (rule SDS-MARKS-004).

StudentClassMark received and the student is not enrolled in a base school or registered as a home-based student at any time between the class start and end dates.


StudentClassMark received and the MarkSource is School and there is a department exam in the course and the educator is not accredited.


StudentClassMark received and there is no educator assigned to the class.


StudentSupplementalMark

XML Message/system actionStudentSupplementalMark received with no CorrectionCode or CorrectionCode=”No” and the student already has a supplemental mark for the indicated course.

StudentSupplementalMark will be rejected (rule SDS-MARKS-004).

of 91


StudentInfo

XML Message/system actionLegal Name provided in conjunction with DeptAssignedPersonId and not matching the individual’s current legal name in the database.

Name will be ignored. Message will indicate appropriate procedure for changing legal name (rule SDS-DEMO-001).

Any Name element includes a period (.). The period will be dropped or replaced by a space (rule DAT-LE-013). No message.

All elements within a Name are completely in uppercase.

Name will be converted to mixed case (lowercase with an initial capital on each separate word) (rule DAT-LE-014). No message.

All elements within a Name are completely in lowercase.

Name will be converted to mixed case (lowercase with an initial capital on each separate word) (rule DAT-LE-014). No message.

HSN provided in conjunction with DeptAssignedPersonId and not matching the individual’s information in the database.

Object will be rejected (rule SDS-DEMO-011). Student Records staff will undertake to resolve the identity of the individual.

Gender provided in conjunction with DeptAssignedPersonId and not matching what is in the database and neither value is U (unknown).

Object will be rejected (rule SDS-DEMO-001). Student Records staff will undertake to resolve the identity of the individual.

Gender provided in conjunction with DeptAssignedPersonId and not matching what is in the database and the XML value is U (unknown).

Gender will be ignored (rule SDS-DEMO-001).

Address does not meet edit rules (see below). Address will be rejected (rule DAT-LE-009). If this is the permanent mailing address of a new student, the student will be rejected (rule SDS-DEMO-002).

Address does not include Country. Country will default to Canada (rule DAT-LE-009). No message.

Address PostalCode is in format ANANAN (no space).

A space will be inserted before editing (rule DAT-LE-009). No message.

Address PostalCode is a string of 9 digits with no punctuation or spaces (U.S. postal code).

A hyphen will be inserted before editing (rule DAT-LE-009. No message.

Permanent mailing address includes EndDate EndDate will be ignored (rule DAT-LE-018).

Address StartDate is prior to the date it is received and prior to the StartDate of the address currently in effect (for the same type of address).

Address will be ignored (rule SDS-DEMO-004).

of 91


TreatyStatusNbr StartDate is prior to the date it is received and prior to the StartDate of the treaty status number in effect.

TreatyStatusNbr will be ignored (rule SDS-DEMO-006).

BandAffiliation StartDate is prior to the date it is received and prior to the StartDate of the band affiliation in effect.

BandAffiliation will be ignored (rule SDS-DEMO-006).

TreatyStatusNbr, BandAffiliation or ReserveResidency StartDate is after the date it is received (future-dated).

TreatyStatusNbr, BandAffiliation or ReserveResidency will be ignored (rule SDS-DEMO-012).

TreatyStatusNbr, BandAffiliation or ReserveResidency included from a school that is not a band school.

Will be ignored (rule SEC-DEMO-001).

TreatyStatusNbr is included and the student has not declared as a treaty/registered/status Indian.

TreatyStatusNbr will be ignored (rule SDS-DEMO-008).

BandAffiliation or ReserveResidency is included and the student has not declared any aboriginal status.

BandAffiliation and ReserveResidency will be ignored (rule SDS-DEMO-008).

Address Edit RulesAn address must include at least one of the following: Street/Line1 Street/Complex Street/StreetNumber Street/StreetNameNote that box number, rural route designation (e.g., RR 7) or “general delivery” can be included in any of the Complex, StreetNumber or StreetName elements.

An address must include City.If the Country is (or is implied to be) Canada: StatePr must be included and must be a valid code for a Canadian province. Postal code must be included (unless this is a physical address), must be in the format

ANA NAN, and must be valid for the indicated province.If the Country is the United States: StatePr must be included and must be a valid code for a U.S. state. Postal code must be included (unless this is a physical address) and must be in the

format NNNNN or NNNNN-NNNN.

SL_Query

XML Message/system actionThe query specifies a DeptAssignedPersonId for an individual who is not already enrolled in or registered in a class delivered by the sending school.

No data will be returned, other than a message indicating that the learning id number is not for a student at the school (rule SEC-XML-003).

of 91


The query specifies a DeptAssignedPersonId that does not correspond to any individual.

No data will be returned, other than a message indicating that the learning id number is not for a student at the school.

Automatic Setting of End DatesThe following end dates will be automatically set in the The Ministry of Education database when new information is received, and thus do not have to be explicitly sent in XML.

If an address is received and accepted, the system will automatically set the end date of the address of the same type in effect prior to the start date of the new address. The exception is if the address is a temporary mailing address and the prior address already has an end date before the start date of the new address (rule DAT-LE-018).

If a TreatyStatusNbr, BandAffiliation, ReserveResidency, Primary E-Mail Address or PhoneNumber element is received and accepted, the system will automatically set the end date of the similar element in effect prior to the start date of the new element (rules DAT-LE-027, 028, 029, 019, 020). Note that if a student has two home phone numbers in effect at the same time, they should both be sent in the same XML object whenever updating the home phone number. Note also that receiving a new Alternate E-Mail Address does not automatically end-date the previous alternate e-mail address (rule DAT-LE-037).

If a StudentProgramEnrollment is received and accepted, the system will automatically set the exit date of the program enrollment in effect prior to the entry date of the new program enrollment (rule DAT-STUREC-034).

of 91

xml dialogues - saskatchewan · web viewrevision history 3 purpose of this document 8 student data...

Documents