XML Dialogues
School
Ministry of
Education
"
Event
"
-
student marks
"
Response
"
-
status of data received
;
errors
Sending student marks
XML for The Ministry of Education’s Student Data System
Updated September 2009
Table of Contents
3Revision History
Purpose of this Document
7
Student Data System XML Dialogues
7
Typical Dialogues
7
Saskatchewan Learning K-12 XML Specification
9
1.
Objects
10
1.1
SchoolTerm
10
1.2
SchoolClass
10
1.3
StudentSchoolEnrollment
11
1.4
StudentProgramEnrollment
11
1.5
StudentPersonal
12
1.6
StudentClassEnrollment
12
1.7
StudentExamRegistration
12
1.8
StudentClassMark
12
1.9
StudentSupplementalMark
12
1.10
StudentCourseHistory – last support is in Release 1.1
14
1.11
StudentExternalCourse
14
1.12
StudentEnrollment
14
1.13
StudentCourseEnrollments
15
1.14
StudentCompletedCourses
17
1.15
DeptCourses
19
1.16
AllStudentClassEnrollments
19
1.17
StudentsNotReEnrolled………………
20
1.18
No Longer Used
21
1.19
StudentPAAModule
21
2.
Elements
22
2.1
TermInfo
22
2.2
ClassIdentification
22
2.3
ClassInfo
23
2.4
StudentIdentification
23
2.5
StudentInfo
24
2.6
SchoolEnrollmentInfo
31
2.7
ProgramEnrollmentInfo
34
2.8
ClassEnrollmentInfo
34
2.9
ExamRegistrationInfo
35
2.10
ExamLocation
36
2.11
SchoolMarkInfo
36
2.12
StudentCourseInfo – last support is in Release 1.1
37
2.13
StudentExternalCourseInfo
37
2.14
StudentClass
38
2.15
StudentDeptExam
38
2.16
CompletedCourse
38
2.17
DeptCourse
39
3.
Queries
40
3.1
SL_QueryObject – last support is in Release 1.1
40
3.2
GeneralQuery
40
3.3
QueryByStudent
41
3.4
QueryBySchool
42
4.
Message Infrastructure
45
4.1
SL_Message
46
4.2
SL_Header
46
4.3
SL_UserCredentials – removed from specification
47
4.4
SL_Event
48
4.5
SL_Request
49
4.6
SL_Response
50
4.7
SL_Ping
53
Appendix A – Country, Language and Province/State Codes
54
Appendix B – Additional Edits
73
SchoolId
75
SchoolClass
75
StudentSchoolEnrollment
75
StudentClassEnrollment
76
StudentClassMark
77
StudentSupplementalMark
77
StudentInfo
78
SL_Query
79
Automatic Setting of End Dates
80
Revision History
Date
Version
Changes
2003 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 ClassId
LearningIDNumber changed to LearningIdNumber
SL_MsgID changed to SL_MsgId
SL_SourceID changed to SL_SourceId
SL_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 CountryOfBirth
CountryofCitizenship changed to CountryOfCitizenship
MediumofInstruction 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 number
SchoolYear 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 StudentSchoolEnrollment
Clarified 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
Date
Version
Changes
2003 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.
Date
Version
Changes
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 added
2004 Jun 21
Release 1.1
Added “Saulteaux” to the list of languages
2004 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 th
