Purpose of this Document

Document Sample
Purpose of this Document Powered By Docstoc
					                                   XML Overview

Purpose of this Document
This document provides an overview and examples of how to use XML to exchange
Student Data System information between schools and Saskatchewan Learning. See
document XML Specifications for the detailed specifications.

The specifications document describes the structure of the XML messages in detail, while
this document provides guidance on which XML message to use for each common task
and what data to include.

Types of Data Exchanges
1. Enrolling a Student
To enroll a student, the school sends full information about the student and the student’s
enrolment, using the XML object StudentSchoolEnrollment with action code = “Add”.
This includes:
 Student identification
    In most cases, this will be the student’s legal name and birth date
    If the student already has a learning id number assigned by Saskatchewan
       Learning and the school knows it, this can be the student’s learning id number and
       birth date instead. If so, the legal name does not have to be included.
 Student demographic information including address and phone number
 Identification number of the school where the student is enrolling
 Indication of whether this is a base school enrolment or a non-base enrolment.
   Defaults to base school enrolment if not specified.
 Enrolment start date, type, and grade
 Previous province, state or country if the student transferred from out-of-province
 Student’s program, if the student is in grade 10, 11 or 12

Example: Enrolling a student in grades K-9

       Examples\2a_SLEvent_StudentSchoolEnrollment_Add.xml

Note: For a student who is already in Saskatchewan Learning’s system, the school can
request demographic information instead of sending it, and then send updates later (see
below).

2. Changing a Student’s Grade
To change a student’s grade (e.g., at the beginning of a new school year), the school uses
object StudentSchoolEnrollment with action code = “Change” to send:
 Student identification (learning id number and birth date)
 School identification number
 Grade for the current school year



Author: Janet Bjorndahl                                                        Page 1 of 5
Last saved: March 8, 2010                                                        7:30 AM
                                   XML Overview

This object should not include any other information (e.g., enrolment start date or type),
although enrolment type 15 (continuation of enrolment at the same school) can be used.

Example:
      Examples\11_SLEvent_StudentSchoolEnrollment_Change.xml

3. Changing a Student’s Program
To Change the program a student is enrolled in (or to identify the program for a student
who just started grade 10), the school uses object StudentProgramEnrollment with action
code = “Change” to send:
 Student identification (learning id number and birth date)
 Program identification number
 The date the student is starting in the new program

Example:
      Examples\2b_SLEvent_StudentProgramEnrollment.xml

4. Withdrawing a Student
To withdraw a student, the school uses object StudentSchoolEnrollment with action code
= “Change” to send:
 Student identification (learning id number and birth date)
 Identification number of the school from which the student is withdrawing
 Withdrawal date
 Withdrawal reason

This object should not include any other information (e.g., enrolment start date or type).

Example:
      Examples\12_SLEvent_StudentSchoolEnrollment_Withdraw.xml

5. Correcting Enrollment Data
Enrolment data that has been sent incorrectly or incompletely can be corrected by using
object StudentSchoolEnrollment, subject to certain restrictions. For example, the
enrolment date can be Changed to an earlier date (but not a later one). The enrolment
type can be Changed. The previous province, state or country can be supplied if it was
missing earlier. After a student has been withdrawn, only the withdrawal type can be
Changed.

To correct enrolment data, the school uses object StudentSchoolEnrollment with action
code = “Change” to send:
 Student identification (learning id number and birth date)
 School identification number
 The data to be fixed



Author: Janet Bjorndahl                                                         Page 2 of 5
Last saved: March 8, 2010                                                         7:30 AM
                                   XML Overview

This object should not include data that does not need to be corrected.

6. Changing a Student’s Demographic Information
To Change a student’s demographic information, the school uses object StudentPersonal
with action code = “Change” to send:
 Student identification (learning id number and birth date)
 Changed student demographic information

Examples:
      Examples\4_SLEvent_StudentPersonal.xml

7. Creating a Class
Before a school can register students in a class, it must create the class using object
SchoolClass with action code = “Add” to send:
 Class identification (school identification number, class start and end dates and class
   unique, unchanging identifier)
 Class information (course(s), teacher(s) and mode of instruction)

Examples:
      Examples\5_SLEvent_SchoolClass.xml

8. Registering a Student in a Class
To register a student in a class, the school uses object StudentClassEnrollment with
action code = “Add” to send:
 Student identification (learning id number and birth date)
 Class identification (school identification number, class start and end dates and class
    unique identifier)
 Class registration information (mode of instruction if different from the norm for the
    class, how mark is to be calculated – defaults if not provided)
 Corresponding department exam registration information, if applicable. Defaults if
    not specified and the registration type is “blended”.

9. Dropping a Student from a Class
To drop a student from a class (and corresponding department exam registration, if
applicable), the school uses object StudentClassEnrollment with action code = “Change”
to send:
 Student identification (learning id number and birth date)
 Class identification (school identification number, class start and end dates and class
    unique identifier)
 Drop information (indication that drop occurred and/or date that drop occurred)




Author: Janet Bjorndahl                                                        Page 3 of 5
Last saved: March 8, 2010                                                        7:30 AM
                                   XML Overview

10. Registering a Student in a Supplemental or Adult Challenge Department
    Exam
To register a student in a supplemental or adult challenge department exam (no class), the
school uses object StudentExamRegistration with action code = “Add” to send:
 Student identification (learning id number and birth date)
 Course number
 Type of exam registration (supplemental or adult challenge)
 Exam period end date
 School identification number of the writing centre

Example:
      Examples\10_SLEvent_StudentExamRegistration.xml

11. Submitting a Class Mark for a Student
To submit the mark for a student in a class, the school uses object StudentClassMark with
action code = “Add” to send:
 Student identification (learning id number and birth date)
 Class identification (school identification number, class start and end dates and class
    unique identifier)
 Student’s school mark

12. Correcting a Class Mark for a Student
To correct a previously submitted mark for a student in a class, the school uses object
StudentClassMark with action code = “Change” to send:
 Student identification (learning id number and birth date)
 Class identification (school identification number, class start and end dates and class
   unique identifier)
 Indication that this is a correction
 Student’s school mark

13. Submitting a Supplemental Mark for a Student
To submit a supplemental mark for a student, the school uses object
StudentSupplementalMark with action code = “Add” to send:
 Student identification (learning id number and birth date)
 School identification number
 Course number
 Teacher’s educator certificate number
 Student’s supplemental mark

Example:
      Examples\8_SLEvent_StudentSupplementalMark.xml




Author: Janet Bjorndahl                                                        Page 4 of 5
Last saved: March 8, 2010                                                        7:30 AM
                                    XML Overview

14. Requesting Student Course History for a Single Student
To request course history for a single student, the school uses a query to request
StudentCourseHistory with scope = “All”, indicating:
 Student identification (learning id number and birth date)

Example:
      Examples\13_SLRequest_StudentCourseHistory_Student.xml

15. Requesting Marks for all Students in a Term
To request marks for all courses for all students in a term, the school uses a query to
request StudentCourseHistory with scope = “Current”, indicating:
 School identification number
 Date range (the query will return all courses for which the final mark was calculated
   or corrected within the date range as well as all transfer credits entered within the date
   range, for all students enrolled in the school during the date range)

Date range could be from the start date of the term to the date that final marks for the
term were completed. If the school is using the returned data to update their own
database, it makes sense that the date range of one request starts the day after the date
range of the previous request. This way, all corrections and transfer credits will be
returned to the school at some point in time.

Note that schools could request a full year of data at a time by specifying a date range
that covers the whole year, but this is not recommended because the resulting file gets too
large.

16. Requesting Non-School Marks for all Students in a Term
If a school wishes to get marks only for courses that include a department exam
component and credits transferred from another province or country, it uses a query to
request StudentCourseHistory with scope = “Dept”, indicating:
 School identification number
 Date range (the query will return all blended and 100% department exam courses for
     which the final mark was calculated or corrected within the date range, as well as all
     transfer credits entered within the date range, for all students enrolled in the school
     during the date range)

17. Requesting Demographic Information for a Single Student
To request demographic information for a single student, the school uses a query to
request StudentPersonal, indicating:
 Student identification (learning id number and birth date)




Author: Janet Bjorndahl                                                          Page 5 of 5
Last saved: March 8, 2010                                                          7:30 AM

				
DOCUMENT INFO