XML Dialogues - Saskatchewan Learning - Welcome to ... · Web viewStudent Data System XML Dialogues...

XML for Saskatchewan Learning’s Student Data System

Table of Contents

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

Typical Dialogues............................................................................................................6Saskatchewan Learning K-12 XML Specification..............................................................8

1. Objects..................................................................................................................91.1 SchoolTerm...........................................................................................................91.2 SchoolClass...........................................................................................................91.3 StudentSchoolEnrollment...................................................................................101.4 StudentProgramEnrollment................................................................................101.5 StudentPersonal..................................................................................................111.6 StudentClassEnrollment.....................................................................................111.7 StudentExamRegistration...................................................................................111.8 StudentClassMark...............................................................................................121.9 StudentSupplementalMark.................................................................................121.10 StudentCourseHistory.........................................................................................132. Elements.............................................................................................................132.1 TermInfo.............................................................................................................132.2 ClassIdentification..............................................................................................142.3 ClassInfo.............................................................................................................142.4 StudentIdentification...........................................................................................152.5 StudentInfo.........................................................................................................162.6 SchoolEnrollmentInfo.........................................................................................232.7 ProgramEnrollmentInfo......................................................................................252.8 ClassEnrollmentInfo...........................................................................................252.9 ExamRegistrationInfo.........................................................................................262.10 ExamLocation.....................................................................................................272.11 SchoolMarkInfo..................................................................................................272.12 StudentCourseInfo..............................................................................................283. Queries................................................................................................................293.1 SL_Query............................................................................................................294. Message Infrastructure........................................................................................324.1 SL_Message........................................................................................................324.2 SL_Header..........................................................................................................334.3 SL_UserCredentials – removed from specification............................................344.4 SL_Event............................................................................................................344.5 SL_Request.........................................................................................................364.6 SL_Response......................................................................................................374.7 SL_Ping..............................................................................................................40

Appendix A – Country, Language and Province/State Codes...........................................41Appendix B – Additional Edits..........................................................................................58

SchoolId.........................................................................................................................60SchoolClass....................................................................................................................60StudentSchoolEnrollment..............................................................................................60

of 65


StudentClassEnrollment................................................................................................61StudentClassMark..........................................................................................................61StudentSupplementalMark............................................................................................61StudentInfo....................................................................................................................63SL_Query.......................................................................................................................64Automatic Setting of End Dates....................................................................................65

of 65


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 65


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 65


2004 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

of 65


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 Saskatchewan Learning, and one or more messages sent from Saskatchewan Learning back to the school (at minimum, Saskatchewan Learning 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 65


of 65


Saskatchewan Learning K-12 XML Specification

The Saskatchewan Learning (SL) K-12 XML specification defines how XML is structured for communication between schools and Saskatchewan Learning. 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 SL 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 SL K-12 XML specifications: For an element A included in a complex element B, “required” means that if element

B is included in an object, it must include element A within it. However, if element B is not included in the object, element A is not required.

For an element A that is included in an object without being part of a complex element, “required” means that element A must be included in the object.

For an attribute A of an element B, “required” means that if element B is included in an object, attribute A must be included and given a value.

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

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

of 65


1. ObjectsThe following objects support transmission of data between schools and Saskatchewan Learning. Schools send objects to Saskatchewan Learning 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.

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.

Examples of each object are in the document XML Examples.

1.1 SchoolTermThis object allows the school to set up their terms, including a brief description or name of each term. It is optional – Saskatchewan Learning 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

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 RequiredClassInfo Required

of 65


1.3 StudentSchoolEnrollmentThis object allows the school to enroll an existing or new student in their school, or to update enrollment information. This is used for quick (real-time) enrollment as well as regular enrollment.

Element Attribute Status Description/NotesStudentSchoolEnrollment

RefId Required The reference ID for returning messages.StudentIdentification RequiredStudentInfo Optional Note: Required if DeptAssignedPersonId

is not included in StudentIdentification.SchoolId Required The department-assigned number of the

school the enrollment is for.SchoolEnrollmentInfo RequiredDeptAssignedProgramId Optional The department-assigned number of the

program the student is enrolling in (see under 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.

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 (rule SEC-ENROL-001).

Element Attribute Status Description/NotesStudentProgramEnrollment

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

program the student is enrolling in (see below).

ProgramEnrollmentInfo Required

Program Numbers10 Regular Program (English)11 Fransaskois Program12 French Immersion/Bilingual Program

of 65


05 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 adults15 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 (rule SEC-DEMO-002). The only action that is allowed for this object is “Change”.

Element Attribute Status Description/NotesStudentPersonal

RefId Required The reference ID for returning messages.StudentIdentification RequiredStudentInfo Required

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 RequiredClassIdentification RequiredClassEnrollmentInfo RequiredExamRegistrationInfo 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, the writing centre is assumed to be the school where the class is being taken (if the student is writing elsewhere, the writing centre can be updated via the Student Data System web application).

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

of 65


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 RequiredDeptAssignedCourseId Required The department-assigned number of the

course whose exam the student plans to write.

ExamRegistrationInfo RequiredExamLocation Required

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 RequiredClassIdentification RequiredSchoolMarkInfo Required

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 RequiredSchoolId Required The department-assigned number of the

school granting the mark.

of 65


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

1.10 StudentCourseHistoryThis object allows Saskatchewan Learning to send 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

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. "2004-2005")

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 Sept 1 of the first calendar year and Aug 31 of the second calendar year) (rule DAT-PGM-010).

Description Optional Text name or description of the term

Example<TermInfo SchoolYear=”2003-2004”>

<StartDate>2004-02-05</StartDate><EndDate>2004-06-28</EndDate><Description>2003-04 Semester 2</Description>

</TermInfo>

of 65


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 9 to 12; homeroom number for other grades), 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>2004-02-05</StartDate><EndDate>2004-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 Optional 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 65


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 Saskatchewan Learning). 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>1987-10-31</BirthDate>

</StudentIdentification>

of 65


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

Note that if the student already exists in the department 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 department 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 65


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. Saskatchewan Learning will not send this. 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 OptionalDemographics/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/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)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.

of 65


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 addressType 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.

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

Required Can be expressed as one or more address lines, or as discrete elements (e.g., street number, street name, street type). Saskatchewan Learning will always send as one or more address lines and will also send as discrete elements if the address was received as discrete elements.

of 65


StudentAddress/Address/Street/Line1

Optional Address line 1. Required if discrete elements not included (rule DAT-LE-009).


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.)

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/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).

of 65


Code Required Country code (see appendix A)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.

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

Gender ValuesM MaleF FemaleU Unknown

Deceased ValuesYes DeceasedNo Not deceased

Aboriginal Status ValuesTreaty Treaty / Registered (Status) IndianNS Non-Status IndianMetis MetisInuit Inuit

of 65


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

Phone Number Format ValuesNA North AmericanFF Free form

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

NoteIf the school does not have the student’s Learning ID Number at the time it enrolls the student, it sends the StudentSchoolEnrollment without the DeptAssignedPersonId. Saskatchewan Learning 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><FirstName>Kathleen</FirstName><MiddleName>Anne</MiddleName><PreferredName>Kathy</PreferredName>

of 65


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

</StudentInfo>

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

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=”2003-09-23”> <Street>

<Line1>Box 1234</Line1>

of 65


</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.5 SchoolEnrollmentInfoThis 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 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 school” 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)Grade Optional Student’s grade. Required when

enrolling a student who has never been enrolled in a Saskatchewan school before.

Code Required Grade code (see below)PreviousProvState Optional The province from which the student

transferred, if applicableCode Required Canadian province code as used by

Canada Post

of 65


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)

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 school03 Transfer from out-of-province schooling within Canada10 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 Saskatchewan Learning’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 CodesP3 Pre-kindergarten (age group of 2 ½ to 3 ½ year olds)PK Pre-kindergarten (age group of 3 ½ to 4 ½ year olds)0K Kindergarten01 Grade 102 Grade 203 Grade 304 Grade 405 Grade 506 Grade 607 Grade 708 Grade 809 Grade 910 Grade 1011 Grade 1112 Grade 12

of 65


Enrollment Outcome and Discontinuation Reason Codes01 Transferred to another Saskatchewan school03 Transferred to out-of-province schooling within Canada10 Transferred to out-of-country schooling13 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”50 Discontinued schooling, with a reason of “employment”52 Discontinued schooling, with a reason of “dissatisfied with school”60 Enrollment cancelled/no show

Example<SchoolEnrollmentInfo MembershipType=”Base”>

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

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

Example<ProgramEnrollmentInfo>

<EntryDate>2003-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

of 65


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

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.

of 65


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>2004-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.

NoteIf a student plans to write in a writing centre other than an education institution, the registration cannot be done via XML. It can be done using the Student Data System web application instead.

Example<ExamLocation >

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

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 student

of 65


CorrectionCode 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 StudentCourseInfoElement 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

courseCode 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

of 65


Example<StudentCourseInfo Type=”Blended”>

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

</StudentCourseInfo>

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

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)

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 QueryStudentPersonal

of 65


StudentCourseHistory

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).

NotesA 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.

There is no explicit query to get the Learning ID Number for a student. Instead, when a school sends a StudentSchoolEnrollment object for a student and the Learning ID Number (DeptAssignedPersonId) is not included, Saskatchewan Learning processes the data received and also treats it as an implied query for the Learning ID Number. See the note under StudentPersonal for more information.

of 65


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>


of 65


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 1.1). Defaults to 1.1 if not specified.

XML Namespace and Related ValuesFor this release of the Saskatchewan Learning K-12 XML specifications, use:

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

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

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

</SL_Message>

of 65


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 Saskatchewan Learning. Saskatchewan Learning 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: Concatentate 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:

select sys_guid() from dual

Note: If a transmission problem prevented Saskatchewan Learning 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.

of 65


Example<SL_Header>

<SL_MsgId>12345678901234567890123456789012</SL_MsgId><SL_Date>2003-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 sentSL_ObjectData/ SL_EventObject

Required and Repeatable

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 (previously sent in error) because it is incorrect. Must

be accompanied by a Reason of “Clerical Error”. Valid only for objects StudentSchoolEnrollment and StudentClassEnrollment.

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

originally sent was incorrect and should be deleted.

of 65


ExamplesChange a student’s phone number

<SL_Message xmlns=”http://www.sasked.gov.sk.ca/xsd/sl/1.x/SLMessage.xsd”xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.sasked.gov.sk.ca/xsd/sl/1.x/SLMessage.xsd http://www.sasked.gov.sk.ca/xsd/sl/1.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>1987-10-31</BirthDate> </StudentIdentification><StudentInfo>

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

</PhoneNumber></StudentInfo>

</StudentPersonal></SL_EventObject>

</SL_ObjectData></SL_Event>

</SL_Message>

Enroll a student in a school (quick enrollment)


<SL_Event><SL_Header>


</SL_Header><SL_ObjectData>

<SL_EventObject ObjectName="StudentSchoolEnrollment" Action="Add"><StudentSchoolEnrollment RefId="1">

of 65


<StudentIdentification> <BirthDate>1987-10-31</BirthDate>

</StudentIdentification><StudentInfo>

<HSN>987654321</HSN><Name Type="Legal">

<LastName>Smith</LastName><FirstName>Kathleen</FirstName><MiddleName>Anne</MiddleName>

</Name></StudentInfo><SchoolId>1234567</SchoolId><SchoolEnrollmentInfo>

<EntryDate>2003-09-02</EntryDate><EntryType Code=”01”/><Grade Code="09"/>

</SchoolEnrollmentInfo></StudentSchoolEnrollment>

</SL_EventObject></SL_ObjectData>

</SL_Event></SL_Message>

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.


xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.sasked.gov.sk.ca/xsd/sl/1.x/SLMessage.xsd http://www.sasked.gov.sk.ca/xsd/sl/1.x/SLMessage.xsd">

<SL_Request><SL_Header>


</SL_Header><SL_Query>

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

of 65


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


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

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

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 to be published later)

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

of 65


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_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 2003-09-23</SL_ErrorMsg>

</SL_Error></SL_Ack>

</SL_Response>

of 65


</SL_Message>

Response to a request for a student’s course history


<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_Ack><SL_ObjectData>

<SL_EventObject ObjectName="StudentCourseHistory" Action="None"><StudentCourseHistory RefId="1">

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

</StudentIdentification><DeptAssignedCourseId>6017</DeptAssignedCourseId><CourseTitle>English Language Arts 20</CourseTitle><StudentCourseInfo Type="School">


</StudentCourseInfo></StudentCourseHistory><StudentCourseHistory RefId="2">

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

</StudentIdentification><DeptAssignedCourseId>8211</DeptAssignedCourseId>

of 65


<CourseTitle>Biology 30</CourseTitle><StudentCourseInfo Type="Blended">


</StudentCourseInfo></StudentCourseHistory>

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


xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.sasked.gov.sk.ca/xsd/sl/1.x/SLMessage.xsd http://www.sasked.gov.sk.ca/xsd/sl/1.x/SLMessage.xsd">

<SL_Ping><SL_Header>


</SL_Header></SL_Ping>

</SL_Message>

of 65


Appendix A – Country, Language and Province/State Codes

Country Codes (source: ISO-3166-1)AF Afghanistan AL Albania DZ Algeria AS American Samoa AD Andorra AO Angola AI Anguilla AQ Antarctica AG Antigua & Barbuda AR Argentina AM Armenia AW Aruba AU Australia AT Austria BS Bahamas BH Bahrain BD Bangladesh BB Barbados BY Belarus (Formerly Byelorussian Soviet Socialist Republic) BE Belgium BZ Belize BJ Benin BM Bermuda BT Bhutan BO Bolivia AZ Bosnia And Herzegovina BW Botswana BV Bouvet Island BR Brazil IO British Indian Ocean Territory VG British Virgin Islands BN Brunei Darussalam BG Bulgaria BF Burkina Faso BU Burma (No Longer Exists) BI Burundi KH Cambodia (Formerly, Democratic Kampuchea) CM Cameroon CA Canada CV Cape Verde KY Cayman Islands CF Central African Republic TD Chad

of 65


CL Chile CN China CX Christmas Island CC Cocos (Keeling) Islands CO Colombia KM Comoros CG Congo CD Congo, The Democratic Republic Of The (Formerly Zaire) CK Cook Islands CR Costa Rica CI Côte D’ivoire (Ivory Coast) HR Croatia CU Cuba 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 TP East Timor EC Ecuador EG Egypt SV El Salvador ER 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 GR Greece GL Greenland GD Grenada

of 65


GU Guam GT Guatemala GW Guinea-Bissau GY Guyana HT Haiti HM Heard Island & McDonald Islands HN Honduras HK Hong Kong HU Hungary IS Iceland IN India ID Indonesia IQ Iraq IE Ireland, Republic OfIR Islamic Republic Of Iran IL Israel IT Italy JM Jamaica JP Japan JO 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 Libyan Arab Jamahiriya LI Liechtenstein LT Lithuania LU Luxembourg MO Macau MK Macedonia (Formerly Yugoslav Republic Of) MG Madagascar MW Malawi MY Malaysia MV Maldives ML Mali MT Malta MH Marshall Islands MQ Martinique

of 65


MR Mauritania MU Mauritius YT Mayotte MX Mexico FM Micronesia MD Moldova, Republic Of MC Monaco MN Mongolian Republic MS Montserrat MA Morocco MZ Mozambique MM Myanmar NA Namibia NR Nauru NP Nepal NL Netherlands AN Netherlands Antilles 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 PA Panama PG Papua New Guinea PY Paraguay PE Peru PH Philippines PN Pitcairn PL Poland PT Portugal PR Puerto Rico QA Qatar RE Réunion RO Romania RU Russian Federation RW Rwanda LC Saint Lucia WS Samoa

of 65


SM San Marino ST Sao Tome & Principe SA Saudi Arabia SN Senegal SC Seychelles SL Sierra Leone SG Singapore SK Slovakia SI Slovenia SB Solomon Islands SO Somalia ZA South Africa GS South Georgia And The South Sandwich Islands ES Spain LK Sri Lanka SH St. Helena KN St. Kitts And Nevis PM St. Pierre & Miquelon VC St. Vincent & The Grenadines SD Sudan SR Suriname SJ Svalbard & 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 TG Togo TK Tokelau TO Tonga TT Trinidad & Tobago TN Tunisia TR Turkey TM Turkmenistan TC Turks & Caicos Islands TV Tuvalu UG Uganda UA Ukraine (Formerly Ukrainian Soviet Socialist Republic) 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

of 65


VI United States Virgin Islands ZZ Unknown Or Unspecified Country UY Uruguay UZ Uzbekistan VU Vanuatu VA Vatican City State (Holy See) VE Venezuela VN Viet Nam WF Wallis & Futuna Islands EH Western Sahara YE Yemen RepublicYU Yugoslavia ZM Zambia (No Longer Exists-See Congo, The Democratic

Republic Of ) ZW Zimbabwe

Language Codes (source: NISO-Z39.53, with additions)The NISO-Z39.53 list (used by SIF) does not have separate codes for all languages within each language group (e.g., Athabascan languages, Aleut languages). 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 AAR AfarAFH Afrihili (Artificial language) AFR Afrikaans AFA Afro-Asiatic (Other) AKA AkanAKK Akkadian ALB Albanian ALE Aleut languagesALG Algonquian languages AJM Aljamia TUT Altaic (Other) AMH Amharic APA Apache languages ARA Arabic ARC Aramaic ARP Arapaho ARN Araucanian ARW Arawak ARM Armenian ART Artificial (Other)

of 65


ASM Assamese AST Asturian; BableATH Athabascan languages AUS Australian languagesMAP Austronesian (Other) AVA Avaric AVE Avestan AWA Awadhi AYM Aymara AZE Azerbaijani NAH Aztec BAN Balinese BAT Baltic (Other) BAL Baluchi BAM Bambara BAI Bamileke languages BAD Banda BNT Bantu languagesBAS Basa BAK Bashkir BAQ Basque BTK Batak (Indonesia)BEJ Beja BEL BelarusianBEM Bemba BEN Bengali BER Berber languages BHO Bhojpuri BIH BihariBIK Bikol BIN Bini BIS BislamaBOS BosnianBRA Braj BRE Breton BUG Buginese BUL Bulgarian BUA BuriatBUR Burmese BEL Byelorussian CAD Caddo CAR Carib CAT Catalan CAU Caucasian (Other) CEB Cebuano CEL Celtic languages

of 65


CAI Central American Indian (Other) 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 COP Coptic COR Cornish COS CorsicanCRE Cree MUS Creek CRP Creoles and Pidgins (Other) CPE Creoles and Pidgins, English-based (Other) CPF Creoles and Pidgins, French-based (Other) CPP Creoles and Pidgins, Portuguese-based (Other) SCR CroatianCUS Cushitic (Other) CZE Czech DAK Dakota DAN Danish DEL Delaware CHP Dene DIN Dinka DIV DivehiDOI Dogri DGR DogribDRA Dravidian (Other) DUA Duala DUT Dutch DUM Dutch, Middle (ca. 1050-1350) DYU Dyula DZO DzongkhaEFI Efik EGY Egyptian EKA Ekajuk

of 65


ELX Elamite ENG English ENM English, Middle (1100-1500) ANG English, Old (ca. 450-1100) ESP Esperanto EST Estonian ETH Ethiopic EWE Ewe EWO Ewondo FAN Fang FAT Fanti FAR Faroese PER FarsiFIJ Fijian FIN Finnish FIU Finno-Ugrian (Other) VLA Flemish FON Fon FRE French FRM French, Middle (ca. 1400-1600) FRO French, Old (ca. 842-1400) FRI Frisian FUR FriulianFUL Fulah GAA GaGAE Gaelic (Scots) GAG Gallegan 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 (Other) GIL Gilbertese GON Gondi GOR GorontaloGOT Gothic GRB Grebo GRC Greek, Ancient (to 1453) GRE Greek, Modern (1453- ) GAA Gþ GUA Guarani GUJ Gujarati

of 65


GWI Gwich'inHAI Haida HAU Hausa HAW Hawaiian HEB Hebrew HER Herero HIL Hiligaynon HIM Himachali HIN Hindi HMO Hiri Motu HUN Hungarian HUP Hupa IBA Iban ICE Icelandic IBO Igbo IJO Ijo ILO Iloko INC Indic (Other) INE Indo-European (Other) IND Indonesian INT Interlingua (International Auxiliary Language Association) ILE InterlingueINU Inuit languagesIKU Inuktitut or InuktutIPK InupiaqIRA Iranian (Other) 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 KAB Kabyle KAC Kachin KAL KalaallisutKAM Kamba KAN Kannada KAU Kanuri KAA Kara-Kalpak KAR Karen KAS Kashmiri KAW Kawi KAZ Kazakh

of 65


KHA Khasi KHM Khmer KHI Khoisan (Other) KHO Khotanese KIK Kikuyu KMB KimbunduKIN Kinyarwanda KIR Kirghiz KOM KomiKON Kongo KOK Konkani KOR Korean KOS KosraeanKPE Kpelle KRO Kru KUA Kuanyama KUM KumykKUR Kurdish KRU Kurukh KUS Kusaie KUT Kutenai LAD Ladino LAH Lahnda LKT LakotaLAM Lamba LAN Langue d’oc (post-1500) LAO Lao LAP Lapp LAT Latin LAV Latvian LTZ LetzeburgeschLEZ LezghianLIN Lingala LIT Lithuanian NDS 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

of 65


MAK Makasar MLA Malagasy MAY Malay MAL Malayalam MLT Maltese MNC ManchuMDR MandarMAN Mandingo MNI Manipuri MNO Manobo languages MAX Manx MAO Maori MAR Marathi CHM MariMAH Marshall MWR Marwari MAS Masai MYN Mayan languages MEN Mende MCH MichifMIC Micmac MIN Minangkabau MIS Miscellaneous (Other) MOH Mohawk MOL Moldavian LOL Mongo MON Mongolian MKH Mon-Khmer (Other) MOS Mossi MUL Multiple languages MUN Munda (Other) NAH NahuatlDAK NakotaNAU NauruNAV Navajo NDE Ndebele, NorthNBL Ndebele, SouthNDO Ndonga NEP Nepali NEW Newari NIA NiasNIC Niger-Kordofanian (Other) SSA Nilo-Saharan (Other)NIU Niuean NON Norse, OldNAI North American Indian (Other)

of 65


SME Northern SamiNSO Northern Sotho NOR Norwegian NOB Norwegian BokmalNNO Norwegian NynorskNUB Nubian languages NYM Nyamwezi NYA Nyanja NYN Nyankole NYO Nyoro NZI Nzima OCI Occitan (post 1500); ProvencalOJI Ojibwa PEO Old Persian (ca. 600-400 B.C.) ORI Oriya GAL Oromo OSA Osage OSS Ossetician; OsseticOTO Otomian languages PAL Pahlavi PAU Palauan PLI Pali PAM Pampanga PAG Pangasinan PAN Panjabi PAP Papiamento PAA Papuan-Australian (Other) PER Persian PEO Persian, Old (ca.600-400 B.C.)PHI Philippine (Other)PHN PhoenicianPON PohnpeianPOL Polish PON Ponape POR Portuguese PRA Prakrit languages PRO Provencal, Old (to 1500) PUS Pushto QUE Quechua ROH Raeto-Romance RAJ Rajasthani RAP RapanuiRAR Rarotongan ROA Romance (Other) RUM Romanian ROM Romany

of 65


RUN Rundi RUS Russian SAL Salishan languages SAM Samaritan Aramaic SMI Sami languages (Other)SAO Samoan SAD Sandawe SAG Sango SAN Sanskrit SAT SantaliSRD SardinianSAS SasakSAU SaulteauxSCO Scots SEL Selkup SEM Semitic (Other) SCC SerbianSRR Serer SHN Shan SHO Shona SID Sidamo SGN Sign LanguagesBLA Siksika SND Sindhi SNH Sinhalese SIT Sino-Tibetan (Other) SIO Siouan languages SIO Sioux DEN Slave (Athapascan)SLA Slavic (Other) SLO Slovak SLV Slovenian SOG SogdianSOM Somali SON Songhai SNK SoninkeWEN Sorbian languages SSO Sotho SAI South American Indian (Other) SPA Spanish SUK Sukuma SUX Sumerian SUN Sundanese SUS Susu SWA Swahili SSW Swati

of 65


SWZ Swazi SWE SwedishSYR Syriac TAG Tagalog TAH Tahitian TAI TaiwaneseTAJ 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 TUR Turkish OTA Turkish, Ottoman TUK Turkmen TVL TuvaluTYV TuvinianTWI Twi UGA Ugaritic UIG Uighur UKR Ukrainian UMB Umbundu UND Undetermined URD Urdu UZB Uzbek VAI Vai VEN Venda VIE Vietnamese VOL Volapuk

of 65


VOT Votic WAK Wakashan languages WAL Walamo WAR Waray WAS Washo WEL Welsh WOL Wolof XHO Xhosa SAH YakutYAO Yao YAP Yapese YID Yiddish YOR Yoruba YPK Yupik languagesZND ZandeZAP Zapotec ZEN Zenaga ZHA ZhuangZUL Zulu ZUN Zuni

Province/State CodesAB Alberta BC British Columbia MB Manitoba 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

of 65


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 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 65


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 65


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 65


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 with action Add received and EducatorInfo is missing.

This class will not appear on the Educator Profile for any teacher. School mark will not be accepted for any students registered in the class until the teacher has been identified (rule SDS-MARKS-002).

SchoolClass 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 Saskatchewan Learning 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

No profile or transcript can be produced until the student’s program is provided

of 65


ProgramEnrollmentInfo or StudentProgramEnrollment and there is no information already on file about what program the student is in.

(rule SDS-RPT-001).

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) Dropped element will be ignored. It will

of 65


and Dropped element is included, and the Dropped element indicates that the student has not dropped the class.

be assumed that the student dropped the class on the indicated ExitDate (rule DAT-STUREC-018).

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 65


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 65


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 65


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 Saskatchewan Learning 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).

NOTE: The system will not automatically set the exit date of a student’s school enrollment when the student enrolls in another school. This is because it is possible for a student to be enrolled in two or more schools at the same time, as long as only one is identified as the student’s base school. Rather than assume that a student has left the previous school, we will assume that a new enrollment as a base school might be incorrect and treat it as a non-base school. If the student has in fact left the previous school, the previous school has to explicitly indicate that (via XML or the web application), after which the new enrollment can be set to be the student’s base school.

of 65

XML Dialogues - Saskatchewan Learning - Welcome to ... · Web viewStudent Data System XML Dialogues...

Documents

Transcript of XML Dialogues - Saskatchewan Learning - Welcome to ... · Web viewStudent Data System XML Dialogues...