Ministry of Education Student Achievement and … · Ministry of Education Student Achievement and...

46
Ministry of Education Student Achievement and Supports XML Specifications Updated January 2017 Page 1 of 46 Table of Contents Revision History ................................................................................................................. 3 Purpose of this Document ................................................................................................... 5 Student Achievement and Supports XML Dialogues ......................................................... 5 Typical Dialogues ........................................................................................................... 5 Student Achievement and Supports XML Specification .................................................... 6 1. Objects ................................................................................................................. 7 1.1 StudentIntensiveSupports .................................................................................... 7 1.2 StudentInclusionInterventionProgramPlan .......................................................... 8 1.3 StudentEnglishAdditionalLanguage .................................................................. 10 1.4 StudentProvincialAssessment ............................................................................ 10 1.5 StudentAttendance ............................................................................................. 11 2. Elements ............................................................................................................. 12 2.1 StudentIdentification .......................................................................................... 12 2.2 IntensiveSupportInfo.......................................................................................... 12 2.3 WhoIsStudentInfo .............................................................................................. 14 2.4 LearningCapacityInfo ........................................................................................ 14 2.5 AssessmentInfo .................................................................................................. 15 2.6 MedicalInfo ........................................................................................................ 16 2.7 AreaOfDevelopmentInfo ................................................................................... 16 2.8 TransitionPlanningInfo ...................................................................................... 19 2.9 AdditionalNotesInfo .......................................................................................... 20 2.10 MeasureableOutcomeInfo .................................................................................. 20 2.11 ServiceInfo ......................................................................................................... 21 2.12 EducationInstituteServiceInfo............................................................................ 22 2.13 SchoolDivisionServiceInfo ................................................................................ 23 2.14 OtherAgencyServiceInfo ................................................................................... 24 2.15 OutcomeAssessmentInfo ................................................................................... 25 2.16 EnglishAdditionalLanguageInfo ........................................................................ 27 2.17 ProvincialAssessmentInfo.................................................................................. 29 2.18 AttendanceInfo ................................................................................................... 32 3. Queries ............................................................................................................... 35 3.1 QueryByStudent ................................................................................................. 35 3.2 QueryBySchool .................................................................................................. 37 4. Message Infrastructure ....................................................................................... 39 4.1 SAS_Message .................................................................................................... 40 4.2 SAS_Header ....................................................................................................... 40 4.3 SAS_Event ......................................................................................................... 42 4.4 SAS_Request ..................................................................................................... 42 4.5 SAS_Response ................................................................................................... 43 4.6 SAS_Ping ........................................................................................................... 44 Appendix A Additional Edits......................................................................................... 46 SchoolId ........................................................................................................................ 46

Transcript of Ministry of Education Student Achievement and … · Ministry of Education Student Achievement and...

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 1 of 46

Table of Contents

Revision History ................................................................................................................. 3 Purpose of this Document ................................................................................................... 5

Student Achievement and Supports XML Dialogues ......................................................... 5 Typical Dialogues ........................................................................................................... 5

Student Achievement and Supports XML Specification .................................................... 6 1. Objects ................................................................................................................. 7 1.1 StudentIntensiveSupports .................................................................................... 7

1.2 StudentInclusionInterventionProgramPlan .......................................................... 8

1.3 StudentEnglishAdditionalLanguage .................................................................. 10

1.4 StudentProvincialAssessment ............................................................................ 10 1.5 StudentAttendance ............................................................................................. 11 2. Elements ............................................................................................................. 12 2.1 StudentIdentification .......................................................................................... 12

2.2 IntensiveSupportInfo.......................................................................................... 12 2.3 WhoIsStudentInfo .............................................................................................. 14

2.4 LearningCapacityInfo ........................................................................................ 14 2.5 AssessmentInfo .................................................................................................. 15 2.6 MedicalInfo ........................................................................................................ 16

2.7 AreaOfDevelopmentInfo ................................................................................... 16 2.8 TransitionPlanningInfo ...................................................................................... 19

2.9 AdditionalNotesInfo .......................................................................................... 20

2.10 MeasureableOutcomeInfo .................................................................................. 20

2.11 ServiceInfo ......................................................................................................... 21 2.12 EducationInstituteServiceInfo............................................................................ 22

2.13 SchoolDivisionServiceInfo ................................................................................ 23 2.14 OtherAgencyServiceInfo ................................................................................... 24 2.15 OutcomeAssessmentInfo ................................................................................... 25

2.16 EnglishAdditionalLanguageInfo ........................................................................ 27 2.17 ProvincialAssessmentInfo.................................................................................. 29 2.18 AttendanceInfo ................................................................................................... 32 3. Queries ............................................................................................................... 35

3.1 QueryByStudent ................................................................................................. 35 3.2 QueryBySchool .................................................................................................. 37

4. Message Infrastructure ....................................................................................... 39 4.1 SAS_Message .................................................................................................... 40 4.2 SAS_Header ....................................................................................................... 40 4.3 SAS_Event ......................................................................................................... 42 4.4 SAS_Request ..................................................................................................... 42

4.5 SAS_Response ................................................................................................... 43 4.6 SAS_Ping ........................................................................................................... 44

Appendix A – Additional Edits......................................................................................... 46

SchoolId ........................................................................................................................ 46

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 2 of 46

SAS_Query ................................................................................................................... 46

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 3 of 46

Revision History

Date Version Changes 2013 Mar 15 Pre-release

2013 Aug 20 1.0 Removed Strength and Interest elements

2013 Oct 07 1.0 Renamed Outcome elements for clarity

2013 Dec 18 1.1 Added student assessment objects and elements

2014 Jan 16 1.1 Simplified student assessment elements

2014 Apr 4 1.1 Changed ‘ORR’ student assessment to ‘Regina Public

Assessment’

2014 May 5 1.1 Changed object and element names for numeracy and

literacy assessments to StudentProvincialAssessment /

ProvincialAssessmentInfo from

StudentStandardizedAssessment /

StandardizedAssessmentInfo.

2014 Aug 27 1.2 Added AssessmentLevel code values 140-142. See page

29.

2014 Dec 10 1.2 Corrected the typo in the header information on page 34 and

page 36.

2014 Dec 18 1.2 Updated Intensive Supports disability code values.

2015 May 27 1.3 Updated description of ProvincialAssessmentInfo element,

provided additional example. IntensiveSupportInfo element

changed; disability code is now required.

AreaOfDevelopmentInfo element code 12 (“Other”) no

longer accepted / supported.

2015 Jul 20 1.4 Modified Additional Edits (Appendix A) to indicate that

SchoolId and SourceId no longer have to match when

submitting ProvincialAssessmentInfo objects.

2015 Nov 16 1.4 Added EYE assessment to ProvincialAssessmentInfo

element.

2015 Nov 17 1.4 Added StudentInclusionInterventionPlan to enumerated list

of object names available to QueryByStudent and

QueryBySchool queries.

2015 Nov 17 1.4 Changed SchoolYear element in

StudentInclusionInterventionProgramPlan from Optional to

Required. Added a note in all applicable

StudentInclusionInterventionProgramPlan elements that

effective dates cannot be future dated.

2016 Jan 13 1.4 Updated valid Area of Development / Support Level code

combinations.

2016 Feb 16 1.4 Added ScopeCode functionality to QueryBySchool and

QueryByStudent query objects.

2016 Apr 25 1.4 Added notes indicating EYE assessment and attendance

data submission is optional.

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 4 of 46

2016 Jun 29 1.4 Added note indicating Number Sense assessment tool is not

in use at this time.

2016 Aug 19 1.4 Updated Query Object notes.

2016 Aug 26 1.4 Updated EAL StartDate / EndDate notes.

2016 Aug 29 1.4 Added code 71 (A) to the enumerated list of valid

assessment level code values for DRA.

2016 Sept 1 1.4 Updated usage notes for StudentInclusionInterventionPlan

query object.

2016 Sept 22 1.4 Updated AssessmentLevel code values (added EYE

assessment “not complete” code).

2016 Oct 20 1.4 Updated Intensive Support Categories and eIIP Learning

Capacity descriptors. Added Writing Assessment and Math

Assessment to the enumerated list of AssessmentTool code

values.

2017 Jan 26 1.4 Corrected AttendanceInfo examples.

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 5 of 46

Purpose of this Document

This document presents the format of XML for exchanging Student Achievement and

Supports information between partners. It does not address the technology of transmitting

and receiving messages (i.e. transport layer).

Student Achievement and Supports XML Dialogues

An XML dialogue, whether real-time or batch, consists of one or more messages sent

from a school to the Ministry of Education, and one or more messages sent from the

Ministry of Education back to the school or school division (at minimum, the Ministry of

Education returns acknowledgement that it received the original messages).

Note that the dialogues presented below imply nothing about the timing of sending

messages – they are the same regardless of whether the school accumulates messages and

sends them in a batch or sends them real-time.

Message types include:

Events (new or changed data)

Requests for data

Responses to requests and events

Typical Dialogues

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 6 of 46

Student Achievement and Supports XML Specification

The Ministry of Education (MOE) Student Achievement and Supports XML specification

defines how XML is structured for communication between schools / school divisions

and The Ministry of Education. It was designed using the Schools Interoperability

Framework (SIF) Implementation Specification (see www.sifinfo.org) as a starting point,

but is not compliant with SIF.

The MOE Student Achievement and Supports XML specification defines the structure of

each object. Each object consists of one or more elements, some of which contain

additional elements within them. Elements may also contain attributes that define the

element. An element that contains elements and/or an attributes is called a complex

element. An element that does not is called a simple element.

Elements and attributes are strings unless otherwise indicated. All dates are in the format

YYYY-MM-DD. Other restrictions on the format and/or contents of the strings are

indicated in the specifications below and in Appendix B. Any element or attribute that is

not considered valid will be rejected and could cause the rejection of the entire object it is

part of. Syntax for elements and attributes follows standard XML syntax.

Note that each object is assigned a RefId (reference ID), which, for event messages, must

be unique within the XML message, so that responses can refer to it. A response, whether

it is an error message or data returned (e.g., return of a student’s Learning ID Number),

will use the same RefId as the object it is responding to.

Queries are also assigned a RefId, which must be unique within the request XML

message. If a query returns many objects (e.g., one query asks for course information on

all students enrolled in a term), all the returned objects will include the RefId of the

query.

In the MOE Student Achievement and Supports 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 the Ministry of Education. Vendors can ignore these.

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 7 of 46

1. Objects

The following objects support transmission of data between schools and the Ministry of

Education. Schools send objects to the Ministry of Education with action codes to

indicate whether each object is to be created, updated or deleted (with limitations on what

can be deleted). See section 4.3 SAS_Event for more information on action codes.

Objects are also used to send data from The Ministry of Education to schools, on request.

Each object consists of a RefId plus one or more elements. The RefId is used to refer to

the object in any messages returned, and must be unique within an event XML message.

(For responses to queries, the RefId is used to identify the query the object is a response

to.) Elements without a description in this section are complex elements, which are

described in section 2 Elements.

1.1 StudentIntensiveSupports

This object allows the school or school division to submit Intensive Supports information

for a student.

Element Attribute Status Description/Notes

StudentIntensiveSupports Provides information about a

student’s Intensive Support

requirements

RefID Required The reference ID for returning

messages

StudentIdentification Required Element 2.1

IntensiveSupportInfo Required See “IntensiveSupportInfo”,

Element 2.2.

Example

<SAS_EventObject ObjectName="StudentIntensiveSupports" Action="Add">

<StudentIntensiveSupports RefId="1">

<StudentIdentification>

<DeptAssignedPersonId>123456789</DeptAssignedPersonId>

<BirthDate>1989-10-31</BirthDate>

</StudentIdentification>

<IntensiveSupportInfo>

<SchoolId>1234567</SchoolId>

<SupportLevel Code="02" SelectedCode="Yes"/>

<Disability Code="01" SelectedCode="Yes"/>

<Disability Code="02" SelectedCode="Yes"/>

<StartDate>2013-09-01</StartDate>

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 8 of 46

<EndDate>2014-07-31</EndDate>

</IntensiveSupportInfo>

</StudentIntensiveSupports >

</SAS_EventObject>

1.2 StudentInclusionInterventionProgramPlan

This object allows the school or school division to submit Inclusion and Intervention

Program Plan (eIIP) information for a student.

Element Attribute Status Description/Notes

StudentInclusionInterventionProgramPlan Provides information about

a student’s inclusion

intervention program plan

RefID Required The reference ID for

returning messages

SchoolYear Required The school year of the

student’s personal program

plan, expressed as both

four-digit calendar years

that the school year spans

with a hyphen between (e.g.

“2015-2016”).

StudentIdentification Required Element 2.1

WhoIsStudentInfo Optional See “WhoIsStudentInfo”

Element 2.3

LearningCapacityInfo Optional See

“LearningCapacityInfo”

Element 2.4

AssessmentInfo Optional

and

Repeatable

See “AssessmentInfo”

Element 2.5

MedicalInfo Optional See “MedicalInfo” Element

2.6

AreaOfDevelopmentInfo Optional

and

Repeatable

See

“AreaOfDevelopmentInfo”

Element 2.7

TransitionPlanningInfo Optional

and

Repeatable

See

“TransitionPlanningInfo”

Element 2.8

AdditionalNotesInfo Optional See “AdditionalNotesInfo”

Element 2.9

MeasureableOutcomeInfo Optional

and

Repeatable

See

“MeasureableOutcomeInfo”

Element 2.10

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 9 of 46

ServiceInfo Optional

and

Repeatable

See “ServiceInfo” Element

2.11

OutcomeAssessmentInfo Optional

and

Repeatable

See

“OutcomeAssessmentInfo”

Element 2.15

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 10 of 46

1.3 StudentEnglishAdditionalLanguage

This object allows the school to submit English as an Additional Language requirements

for a student.

Element Attribute Status Description/Notes

StudentEnglishAdditionalLanguage Provides information about a

student’s English as an Additional

Language requirements

RefID Required The reference ID for returning

messages

StudentIdentification Required Element 2.1

EnglishAdditionalLanguageInfo Required See

“EnglishAdditionalLanguageInfo”

Element 2.16

Example

<SAS_EventObject ObjectName="StudentEnglishAdditionalLanguage" Action="Add">

< StudentEnglishAdditionalLanguage RefId="1">

<StudentIdentification>

<DeptAssignedPersonId>123456789</DeptAssignedPersonId>

<BirthDate>1989-10-31</BirthDate>

</StudentIdentification>

<EnglishAdditionalLanguageInfo>

<SchoolId>1234567</SchoolId>

<ProficiencyLevel Code="01" SelectedCode="Yes"/>

<StartDate>2012-09-01</StartDate>

<EndDate>2013-07-31</EndDate>

</ EnglishAdditionalLanguageInfo >

</ StudentEnglishAdditionalLanguage >

</SAS_EventObject>

1.4 StudentProvincialAssessment

This object allows the school or school division to submit provincial assessment

information for a student.

Element Attribute Status Description/Notes

StudentProvincialAssessment Provides information about a

student’s provincial assessments.

RefID Required The reference ID for returning

messages

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 11 of 46

StudentIdentification Required Element 2.1

ProvincialAssessmentInfo Required

and

Repeatable

See

“ProvincialAssessmentInfo”,

Element 2.17.

Example

<SAS_EventObject ObjectName="StudentProvincialAssessment" Action="Add">

< StudentProvincialAssessment RefId="1">

<StudentIdentification>

<DeptAssignedPersonId>123456789</DeptAssignedPersonId>

<BirthDate>1989-10-31</BirthDate>

</StudentIdentification>

<ProvincialAssessmentInfo>

<SchoolId>1234567</SchoolId>

<AssessmentTool Code="07" SelectedCode="Yes"/>

<AssessmentElement Code="02"/>

<AssessmentLevel Code=”100”/>

<AssessmentDate>2013-09-01</AssessmentDate>

</ ProvincialAssesmentInfo >

</ StudentProvincialAssessment >

</SAS_EventObject>

1.5 StudentAttendance

This object allows for submission of attendance information for a student.

** Currently, implementation of this object is optional.

Element Attribute Status Description/Notes

StudentAttendance Provides information about a

student’s attendance.

RefID Required The reference ID for returning

messages

StudentIdentification Required Element 2.1

AttendanceInfo Required

and

Repeatable

See “AttendanceInfo”, Element

2.18.

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 12 of 46

2. Elements

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

2.1 StudentIdentification

Used to identify a student. 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.

Element Attribute Status Description/Notes

StudentIdentification Identifies a student (in conjunction with

information in StudentInfo if the Learning ID

Number is not included).

DeptAssignedPersonId Required Learning ID Number (assigned by The

Ministry of Education). Must be a 9-digit

number that exists on the ministry SDS

database.

BirthDate Required The student's date of birth. Used to ensure

that the correct record is being referenced.

Cannot be used to update the birth date of an

existing student.

Example

<StudentIdentification>

<DeptAssignedPersonId>123456789</DeptAssignedPersonId>

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

</StudentIdentification>

2.2 IntensiveSupportInfo

This element provides information about the Intensive Supports for a student.

Element Attribute Status Description/Notes

IntensiveSupportInfo Provides detailed information

about a student’s Intensive

Supports

SchoolId Required The department-assigned

number of the school providing

the Intensive Supports

SupportLevel Required Intensive Support level

Code Required See SupportLevel Code Values

SelectedCode Required See SupportLevel SelectedCode

Values

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 13 of 46

Disability Required

and

Repeatable

Disability(s) to be

added/removed from student’s

Intensive Support profile. Only

two disabilities will be accepted

for a student; additional

disabilities will be ignored.

Code Required See Disability Code Values

SelectedCode Required See Disability SelectedCode

Values

StartDate Optional Effective start date of the

disability(s). The start date

must fall within the current

school year. Defaults to date of

XML if not specified.

EndDate Optional Effective end date of the

disability(s). The end date must

fall within the current school

year. Defaults to July 31 of the

current school year if not

specified. Rejected if prior to

start date.

SupportLevel Code Values

01 Occasional

02 Frequent

SupportLevel SelectedCode Values

Yes SupportLevel exists for student (i.e. add support level)

No SupportLevel does not exist for student (i.e. remove support level)

NOTE: removing a support level will remove all disabilities associated with that

support level.

Disability Code Values

01 Blind or Visual Impairment

02 Deaf or Hard of Hearing

03 Intellectual Disability

04 Bipolar, Depressive, Anxiety or Related Disorders

05 [Deprecated – no longer used]

06 Orthopaedic Disability

07 Other Diagnosed condition

08 Autism Spectrum Disorder

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 14 of 46

09 Physical Health Impairment

10 Neurodevelopmental Disorder associated with prenatal substance exposure

11 Substance-related and Addictive Disorders

12 Undiagnosed condition

Disability SelectedCode Values

Yes Disability exists for student (i.e. add disability)

No Disability does not exist for student (i.e. remove disability)

Example

<IntensiveSupportInfo>

<SchoolId>1234567</SchoolId>

<SupportLevel Code="02" SelectedCode="Yes"/>

<Disability Code="01" SelectedCode="Yes"/>

<Disability Code="02" SelectedCode="Yes"/>

<StartDate>2011-09-01</StartDate>

<EndDate>2012-07-31</EndDate>

</IntensiveSupportInfo>

2.3 WhoIsStudentInfo

This element provides information about the eIIP strengths, interests, and learning styles

for a student.

Element Attribute Status Description/Notes

WhoIsStudentInfo Provides information about a

student’s strengths, interests, and

learning styles for his/her eIIP.

WhoIsStudent Required Narrative describing student

strengths, interests, and learning

styles.

WhoIsStudentDate Required Effective date of strengths,

interests, and learning styles.

Cannot be future dated.

2.4 LearningCapacityInfo

This element provides information about the eIIP Learning Capacity for a student.

Element Attribute Status Description/Notes

LearningCapacityInfo Provides information about a

student’s learning capacity for

his/her eIIP.

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 15 of 46

LearningCapacity Required Learning capacity

Code Required See LearningCapacity Code

Values

SelectedCode Required See LearningCapacity

SelectedCode Values

LearningCapacityDate Required Effective date of Learning

capacity. Cannot be future

dated.

LearningCapacity Code Values

01 Above average ability

02 Average ability

03 Below average ability

04 Borderline Intellectual Ability [Deprecated – no longer used]

05 Significantly below average ability

06 Ability not formally assessed

07 Ability cannot be reported due to the variability of the results

08 Ability is not known at this time

LearningCapacity SelectedCode Values

Yes LearningCapacity code exists for student (i.e. add Learning Capacity)

No LearningCapacity code does not exist for student (i.e. remove Learning Capacity)

2.5 AssessmentInfo

This element provides information about the eIIP Assessment for a student.

Element Attribute Status Description/Notes

AssessmentInfo Provides information about a

student’s assessment for his/her

eIIP.

DiagnosisStatus Required Diagnosis status for the student.

Code Required See DiagnosisStatus Code

Values

SelectedCode Required See DiagnosisStatus

SelectedCode Values

DiagnosisDescription Required Description of the student’s

diagnosis.

ProfessionalDescription Required Professional / Agency who

completed student’s diagnosis /

assessment.

AssessmentYear Required Year student’s assessment was

completed, in YYYY format.

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 16 of 46

AssessmentDate Required Effective date of student’s

assessment. Cannot be future

dated.

DiagnosisStatus Code Values

01 Undiagnosed

02 Diagnosed

DiagnosisStatus SelectedCode Values

Yes DiagnosisStatus code exists for student (i.e. add Diagnosis Status)

No DiagnosisStatus code does not exist for student (i.e. remove Diagnosis Status)

2.6 MedicalInfo

This element provides information about the eIIP Medical information for a student.

Element Attribute Status Description/Notes

MedicalInfo Provides information about a

student’s medical information for

his/her eIIP.

MedicalDescription Required Pertinent assessment, medications,

or procedures that may impact

student’s school performance.

MedicalDate Required Effective date of student’s medical

information. Cannot be future

dated.

2.7 AreaOfDevelopmentInfo

This element provides information about the eIIP Areas of Development for a student.

Element Attribute Status Description/Notes

AreaOfDevelopmentInfo Provides information about a

student’s areas of development

for his/her eIIP.

AreaOfDevelopment Required Specific area of development

required for student.

Code Required See AreaOfDevelopment Code

Values

SelectedCode Required See AreaOfDevelopment

SelectedCode Values

SupportLevel Required Support level for the

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 17 of 46

corresponding area of

development

Code Required See SupportLevel Code Values

AreaOfDevelopmentDate Required Effective date of area of

development. Cannot be future

dated.

AreaOfDevelopment Code Values

01 Academic Achievement

02 Communication

03 Health / Medical Need / Personal Care

04 Independence

05 Motor Skills

06 Personal / Social Well-being

07 Safety

08 Sensory

09 Transition – Daily

10 Transition – Long-term

11 Transition – Short-term

12 Other (no longer accepted / supported)

** Valid AreaOfDevelopment / SupportLevel codes:

AreaOfDeveopment Code Valid SupportLevel Codes

01 01, 02, 03, 04

02 05, 06, 07, 08

03 29, 30, 31, 32

04 09, 10, 11, 12

05 13, 14, 15, 16

06 25, 26, 27, 28

07 21, 22, 23, 24

08 17, 18, 19, 20

09 33, 34, 35, 36

10 33, 34, 35, 36

11 33, 34, 35, 36

12 none

AreaOfDevelopment SelectedCode Values

Yes AreaOfDevelopment code exists for student (i.e. add Area of Development)

No AreaOfDevelopment code does not exist for student (i.e. remove Area of

Development)

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 18 of 46

SupportLevel Code Values

01 Performing at or above expected achievement based on individual learning

capacity.

02 Performing at expected achievement with specific adaptations and supports based

on individual learning capacity.

03 Performing below expected achievement with specific adaptations and supports

based on individual learning capacity.

04 Unable to demonstrate expected achievement with intensive adaptations and

supports based on individual learning capacity.

05 Effectively understands and expresses ideas, thoughts, and needs in a manner

similar to same-age peers.

06 Occasionally has difficulty understanding and/or expressing ideas/thoughts and

needs; requires prompts and supports.

07 Frequently has difficulty understanding and/or expressing ideas, thoughts and

needs; requires prompts and supports.

08 Requires intensive support to communicate basic needs and wants.

09 Completes tasks and follows instructions in a manner similar to same-age peers.

10 Completes tasks and follows instructions with occasional assistance and

supervision.

11 Completes tasks and follows instructions with frequent assistance and

supervision.

12 Completes tasks with continuous assistance and supervision.

13 Does not require assistance with age-expected motor activities.

14 Occasionally requires assistance with certain age-expected motor activities.

15 Frequently requires assistance with age-expected motor activities.

16 Continuously requires assistance with age-expected motor activities.

17 Readily regulates sensory information presented in the environment.

18 Occasionally experiences difficulty regulating sensory information.

19 Frequently experiences difficulty regulating sensory information.

20 Continuously requires intensive, individual sensory programming to regulate

sensory information.

21 No threat of harm to self or others.

22 Requires occasional supervision to ensure no harm to self or others.

23 Requires frequent supervision and prompting to ensure no harm to self or others.

24 Requires intensive supervision and behavioural intervention to ensure no harm to

self or others.

25 Generally demonstrated positive age-expected emotional health and social skills.

26 Occasionally benefits from support in developing age-expected emotional health

and social skills.

27 Frequently benefits from support in developing age-expected emotional health

and social skills.

28 Requires intensive support in developing age-expected emotional health and

social skills.

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 19 of 46

29 No health needs and/or medical condition is currently well managed.

30 Requires occasional monitoring and/or assistance with health and/or personal care

needs.

31 Requires frequent monitoring and/or assistance with health and/or personal care

needs.

32 Requires intensive monitoring and/or assistance with health and/or personal care

needs.

33 Does not require assistance during transitioning.

34 Requires occasional assistance during transitioning.

35 Requires frequent assistance during transitioning.

36 Requires continuous assistance during transitioning.

37 Does not require assistance.

38 Requires occasional assistance.

39 Requires frequent assistance.

40 Requires continuous assistance.

2.8 TransitionPlanningInfo

This element provides information about the eIIP Transition Planning information for a

student.

Element Attribute Status Description/Notes

TransitionPlanningInfo Provides information about

a student’s short and long-

term transition planning for

his/her eIIP.

TransitionDuration Required Duration of transition

required for student

Code Required See TransitionDuration

Code Values.

SelectedCode Required See TransitionDuration

SelectedCode Values

TransitionPlanningDescription Required Description of transition

planning.

TransitionPlanningDate Required Effective date of transition

planning. Cannot be future

dated.

TransitionDuration Code Values

01 Short-term

02 Long-term

TransitionDuration SelectedCode Values

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 20 of 46

Yes TransitionDuration code exists for student (i.e. add Transition Duration)

No TransitionDuration code does not exist for student (i.e. remove Transition

Duration)

2.9 AdditionalNotesInfo

This element provides additional notes about the student’s eIIP.

Element Attribute Status Description/Notes

AdditionalNotesInfo Provides additional notes about the

student’s eIIP.

AdditionalNotes Required Narrative describing student

additional notes.

AdditionalNotesDate Required Effective date of student additional

notes. Cannot be future dated.

2.10 MeasureableOutcomeInfo

This element provides information about the Measureable Outcome evaluation for a

student.

Element Attribute Status Description/Notes

MeasureableOutcomeInfo Measureable outcome

information for student’s

eIIP.

AreaOfDevelopment Required Area of development

required for student.

Code Required See AreaOfDevelopment

Code Values Element 2.7

MeasureableOutcomeTarget Required Narrative of desired

measureable future

outcome.

MeasureableOutcomeCurrent Required Narrative of current student

status w/r to measureable

outcome.

MeasureableOutcomeSource Required

and

Repeatable

Source(s) of measureable

outcome assessment.

Code Required See

MeasureableOutcomeSource

Code Values

SelectedCode Required See

MeasureableOutcomeSource

SelectedCode Values

MeasureableOutcomeResponsibility Required Person responsible for

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 21 of 46

measureable outcome

assessment.

MeasureableOutcomeStrategies Required Strategies to support

achievement of measureable

student outcome.

MeasureableOutcomeEvaluationDate Required Effective date of

measureable outcome

evaluation. Cannot be

future dated.

MeasureableOutcomeSource Code Values

01 Anecdotal Records

02 Checklist

03 Communication Logs

04 Grade Level / Curricula

05 Peer Evaluation

06 Portfolios

07 Rubrics

08 Standardized Test

09 Work Samples

10 Other

MeasureableOutcomeSource SelectedCode Values

Yes MeasureableOutcomeSource code exists for student (i.e. add Measureable

Outcome Source)

No MeasureableOutcomeSource code does not exist for student (i.e. remove

Measureable Outcome Source)

2.11 ServiceInfo

This element provides information about the Service Information for a student.

Element Attribute Status Description/Notes

ServiceInfo Provides information about a

student’s service information

for his/her eIIP.

AreaOfDevelopment Required Area of development required

for student.

Code Required See AreaOfDevelopment Code

Values Element 2.7

EducationInstituteServiceInfo Optional

and

Repeatable

See

“EducationInstituteServiceInfo”

Element 2.12

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 22 of 46

SchoolDivisionServiceInfo Optional

and

Repeatable

See

“SchoolDivisionServiceInfo”

Element 2.13

OtherAgencyServiceInfo Optional

and

Repeatable

See “OtherAgencyServiceInfo”

Element 2.14

2.12 EducationInstituteServiceInfo

This element provides information about the Education Institute Service Information for

a student.

Element Attribute Status Description/Notes

EducationInstituteServiceInfo Provides information about a

student’s school service for

his/her eIIP.

Service Required Service required for student

(valid codes are 01-06)

Code Required See Service Code Values

SelectedCode Required See Service SelectedCode

Values

ServiceSupportRequirement Required Level of support needed for

service

Code Required See

ServiceSupportRequirement

Code Values

ServiceSupportDescription Optional Narrative of other support

service (only valid with

Service Code 06)

ServiceDate Required Effective date of Education

Institute Service. Cannot be

future dated.

Service Code Values

01 Administrator

02 Classroom Teacher

03 Education / Teacher Assistant

04 Parent / Caregiver

05 Student Support Services Teacher

06 Other School Service

07 Counselor / Social Worker

08 Consultant

09 English as Additional Language Specialist

10 Occupational Therapist

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 23 of 46

11 Nurse

12 Physical Therapist

13 Psychologist

14 Speech Language Pathologist

15 Supervisor / Coordinator

16 Other School Division Service

17 Community Based Organizations

18 Corrections, Public Safety & Policing

19 Elders

20 Health

21 Social Services

22 Other Agency Service

Service SelectedCode Values

Yes Service code exists for student (i.e. add Service)

No Service code does not exist for student (i.e. remove Service)

ServiceSupportRequirement Code Values

01 Frequently: Every day on a regular schedule, at least 2-3 times per week.

02 Occasionally: Scheduled blocks, at least once per week.

03 Periodically: Less than once per week or specific activities at times of need.

2.13 SchoolDivisionServiceInfo

This element provides information about the Education Institute Service Information for

a student.

Element Attribute Status Description/Notes

SchoolDivisionServiceInfo Provides information about a

student’s school division

service for his/her eIIP.

Service Required Service required for student

(valid codes are 07-16)

Code Required See Service Code Values

SelectedCode Required See Service SelectedCode

Values

ServiceSupportRequirement Required Level of support needed for

service

Code Required See

ServiceSupportRequirement

Code Values

ServiceSupportDescription Optional Narrative of other support

service (only valid with

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 24 of 46

Service Code 16)

ServiceDate Required Effective date of School

Division Service. Cannot be

future dated.

ServiceSupportRequirement Code Values

01 Frequently: Direct service, regular consultation.

02 Occasionally: Set up and monitor student programming.

03 Periodically: Specific activities or times of need.

2.14 OtherAgencyServiceInfo

This element provides information about the Intensive Supports / Other Agency Service

Information for a student.

Element Attribute Status Description/Notes

OtherAgencyServiceInfo Provides information about a

student’s other agency or

support service for his/her

eIIP.

Service Required Service required for student

(valid codes are 17-22)

Code Required See Service Code Values

SelectedCode Required See Service SelectedCode

Values

ServiceSupportRequirement Required Level of support needed for

service

Code Required See

ServiceSupportRequirement

Code Values

ServiceSupportDescription Optional Narrative of other support

service (only valid with

Service Code 22)

ServiceDate Required Effective date of Other

Agency Service. Cannot be

future dated.

ServiceSupportRequirement Code Values

01 Frequently: Regular involvement or monitoring.

02 Occasionally: Set up and monitor student programming.

03 Periodically: Specific activities or times of need.

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 25 of 46

2.15 OutcomeAssessmentInfo

This element provides an assessment of progress on the Measureable Outcome evaluation

for a student.

Element Attribute Status Description/Notes

OutcomeAssessmentInfo Progress on measureable

outcome for student’s eIIP.

SelectedCode Required See

MeasureableOutcomeSource

SelectedCode Values,

Element 2.10

AreaOfDevelopment Required Area of development

required for student.

Code Required See AreaOfDevelopment

Code Values Element 2.6

MeasureableOutcomeTarget Required Narrative of desired

measureable outcome.

OutcomeProgress Required Student progress on

outcome.

Code Required See OutcomeProgress Code

Values (see below).

SelectedCode Required See

MeasureableOutcomeSource

SelectedCode Values,

Element 2.10

OutcomeAssessment Required Narrative to describe

measureable outcome

assessment / progress.

OutcomeAssessmentSource Required

and

Repeatable

(up to 4)

Source of Outcome

evaluation.

Code Required See

MeasureableOutcomeSource

Code Values, Element 2.10

SelectedCode Required See

MeasureableOutcomeSource

SelectedCode Values,

Element 2.10

OutcomeAssessmentStrategies Required Narrative to describe next

steps towards achievement

of outcome, or if achieved,

next steps for the student.

OutcomeAssessmentDate Required Effective date of outcome

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 26 of 46

assessment. Cannot be

future dated.

OutcomeProgress Code Values

01 Experiencing Difficulty

02 Making Progress – Less than expected

03 Making Progress – As expected

04 Outcome Achieved

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 27 of 46

2.16 EnglishAdditionalLanguageInfo

This element provides information about the English as an Additional Language

requirements for a student.

Element Attribute Status Description/Notes

EnglishAdditionalLanguageInfo Provides detailed

information about a

student’s English as an

Additional Language

requirements

SchoolId Required The department-assigned

number of the school

providing the English as

an Additional Language

supports

ProficiencyLevel Required English as an Additional

Language support level

Code Required See ProficiencyLevel

Code Values

SelectedCode Required See ProficiencyLevel

SelectedCode Values

StartDate Optional Effective start date of the

Proficiency Levels. The

start date must fall within

the current school year.

Cannot be prior to

student’s school

enrolment start date. If

not specified, defaults to

the submission date.

EndDate Optional Effective end date of the

Proficiency Levels. The

end date must fall within

the current school year.

Defaults to July 31 of the

current school year if not

specified. Cannot be prior

to StartDate.

ProficiencyLevel Code Values

01 A1 – Level 1 (A1.1)

02 A1 – Level 2 (A1.2)

03 A2 – Level 1 (A2.1)

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 28 of 46

04 A2 – Level 2 (A2.2)

05 B1 – Level 1 (B1.1)

06 B1 – Level 2 (B1.2)

ProficiencyLevel SelectedCode Values

Yes ProficiencyLevel exists for student (i.e. add Proficiency Level)

No ProficiencyLevel does not exist for student (i.e. remove Proficiency Level)

Example

<EnglishAdditionalLanguageInfo>

<SchoolId>1234567</SchoolId>

<ProficiencyLevel Code="01" SelectedCode="Yes"/>

<StartDate>2012-09-01</StartDate>

<EndDate>2013-07-31</EndDate>

</ EnglishAdditionalLanguageInfo >

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 29 of 46

2.17 ProvincialAssessmentInfo

This element provides information about the provincial assessment (literacy and

numeracy) information for a student.

Note that the Early Years Evaluation (EYE) assessment tool is for Ministry of Education

use only; not to be submitted by school divisions.

Element Attribute Status Description/Notes

ProvincialAssessmentInfo Provides detailed

information about a

student’s provincial

assessments.

SchoolId Required The department-assigned

number of the school

recording the provincial

assessment information.

AssessmentTool Required Provincial student

assessment tool.

Code Required See AssessmentTool Code

Values

SelectedCode Required See AssessmentTool

SelectedCode Values

AssessmentElement Optional This element is for

Number Sense and EYE

only: Provincial student

assessment tool element.

Code Required See AssessmentElement

Code Values.

AssessmentLevel Required Provincial student

assessment level.

Code Required See AssessmentLevel

Code Values.

AssessmentDate Optional Effective start date of the

provincial assessment.

Defaults to date of XML

submission if not

specified.

AssessmentTool Code Values

01 Reading Recovery

02 Northern Lights

03 Regina Public Assessment

04 Fountas & Pinnell

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 30 of 46

05 DRA (Developmental Reading Assessment)

06 PM Benchmark

07 Number Sense – not in use at this time

08 GB+

09 Alpha-jeunes

10 EYE (Early Years Evaluation) – for Ministry of Education use only

11 Writing Assessment

12 Math Assessment

99 Not Assessed / Non-Évalué

AssessmentTool SelectedCode Values

Yes AssessmentTool exists for student (i.e. add assessment)

No AssessmentTool does not exist for student (i.e. remove assessment)

AssessmentElement Code Values (Number Sense and EYE only)

01 A – not in use at this time

02 B – not in use at this time

03 C – not in use at this time

04 D – not in use at this time

05 E – not in use at this time

06 F – not in use at this time

07 G – not in use at this time

08 H – not in use at this time

09 ASEGP (Awareness of Self and Environment)

10 SOCGP (Social Skills and Approaches to Learning)

11 COGGP (Cognitive Skills)

12 LNGGP (Language and Communication)

13 PHYFINEGP (Physical Development – Fine Motor)

14 PHYGROSSGP (Physical Development – Gross Motor)

15 RTI

AssessmentLevel Code Values

Code Corresponding

Assessment Code

Assessment Tool / Data Rules

01 – 70 01-70 01-22, 24, 26, 27, 28, 30, 32, 34

(Reading Recovery);

01-27 (Northern Lights);

01-10, 12, 14, 16, 18, 20 (Regina

Public Assessment);

01-04, 06, 08, 10, 12, 14, 16, 18,

20, 24, 28, 30, 34, 38, 40, 44, 50,

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 31 of 46

60, 70 (DRA);

01-30 (PM Benchmark);

01-30 (GB+);

01-04 (EYE: for developmental

levels use 01=red, 02=yellow,

03=green, 04=not complete; for

RTI level use 01=green,

02=yellow, 03=red, 04=not

complete);

01-04 (Writing Assessment);

01-04 (Math Assessment).

71 – 96 A-Z Fountas & Pinnell (71-96

inclusive), Alpha-jeunes (83-96

inclusive), DRA (71 only).

97 B / E Number Sense (English / French)

98 A / D Number Sense (English / French)

99 P / A Number Sense (English / French)

100 M Number Sense (English & French)

101 SNR / PP Number Sense (English / French)

102 - 139 A1, B2, C3, C4, D5,

D6, E7, E8, F9, F10,

G11, G12, H13,

H14, I15, I16, I17,

J18, J19, J20, K21,

K22, L23, L24

Alpha-jeunes

140 80 DRA

141 NA / NÉ Not Assessed / Non-Évalué,

Number Sense, Writing

Assessment, Math Assessment.

142 NM Reading Recovery, Northern

Lights, Regina Public Assessment,

Fountas & Pinnell, DRA, PM

Benchmark, GB+, Alpha-jeunes,

Number Sense, Writing

Assessment, Math Assessment.

Example

Add Fountas & Pinnell reading assessment results:

<ProvincialAssessmentInfo>

<SchoolId>1234567</SchoolId>

<AssessmentTool Code="04" SelectedCode="Yes"/>

<AssessmentLevel Code=”75”/>

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 32 of 46

<AssessmentDate>2015-04-09</AssessmentDate>

</ ProvincialAssesmentInfo >

Add Number Sense numeracy assessment results:

<ProvincialAssessmentInfo>

<SchoolId>1234567</SchoolId>

<AssessmentTool Code="07" SelectedCode="Yes"/>

<AssessmentElement Code="02"/>

<AssessmentLevel Code=”100”/>

<AssessmentDate>2013-09-01</AssessmentDate>

</ ProvincialAssesmentInfo >

Add “No Assessment” results for student:

<ProvincialAssessmentInfo>

<SchoolId>1234567</SchoolId>

<AssessmentTool Code="99" SelectedCode="Yes"/>

<AssessmentLevel Code=”141”/>

<AssessmentDate>2014-09-01</AssessmentDate>

</ ProvincialAssesmentInfo >

Add EYE assessment results (RTI):

<ProvincialAssessmentInfo>

<SchoolId>1234567</SchoolId>

<AssessmentTool Code="10" SelectedCode="Yes"/>

<AssessmentElement Code="15"/>

<AssessmentLevel Code=”01”/>

<AssessmentDate>2015-11-16</AssessmentDate>

</ ProvincialAssesmentInfo >

2.18 AttendanceInfo

This element provides information about the attendance information for a student.

** Currently, implementation of this element is optional.

Element Attribute Status Description/Notes

AttendanceInfo Provides detailed

information about a

student’s attendance.

SchoolId Required The department-assigned

number of the school

reporting the student

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 33 of 46

attendance information.

CourseId Optional The course number code

for the attendance, if

attendance is reported by

course.

ReportingPeriod Required Description of the

attendance reporting

period.

Code Required See ReportingPeriod code

values below.

SelectedCode Required See SelectedCode values

below.

StartDate Required Effective start date of the

attendance period.

Cannot be prior to

student’s school

enrolment start date.

EndDate Required Effective end date of the

attendance period.

Cannot be after the

student’s school

enrolment end date.

Possible Required Possible count in the

attendance session (i.e.

possible days or course

periods attended).

Absent Required Absent count in the

attendance session (i.e.

absent days or course

periods missed).

ReportingDate Optional Effective reporting date of

the student attendance

information. Defaults to

date of XML submission

if not specified.

ReportingPeriod Code Values

01 Daily attendance (not supported at this time)

02 Weekly attendance (not supported at this time)

03 Biweekly attendance (not supported at this time)

04 Monthly attendance

05 Quarterly attendance (not supported at this time)

06 Semiannual attendance (not supported at this time)

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 34 of 46

07 Annual attendance (not supported at this time)

SelectedCode Values

Yes ReportingPeriod exists for student (i.e. add attendance information)

No ReportingPeriod does not exist for student (i.e. remove attendance information)

Example

Add monthly attendance information for course code 900 (ELA 9):

<AttendanceInfo>

<SchoolId>1234567</SchoolId>

<CourseId>900</CourseId>

<ReportingPeriod Code="04" SelectedCode="Yes"/>

<StartDate>2016-02-01</StartDate>

<EndDate>2016-02-29</EndDate>

<Possible>20</Possible>

<Absent>1</Absent>

<ReportingDate>2016-03-01</ReportingDate>

</AttendanceInfo >

Add monthly non-course specific attendance information:

<AttendanceInfo>

<SchoolId>1234567</SchoolId>

<ReportingPeriod Code="04" SelectedCode="Yes"/>

<StartDate>2016-02-01</StartDate>

<EndDate>2016-02-29</EndDate>

<Possible>20</Possible>

<Absent>0.5</Absent>

<ReportingDate>2016-03-01</ReportingDate>

</AttendanceInfo >

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 35 of 46

3. Queries

Query allows a school to request certain data. There are a limited number of pre-defined

queries that are supported.

3.1 QueryByStudent

This allows the school to request information about one student.

Element Attribute Status Description/Notes

QueryByStudent A request to return information for a

specific student.

RefId Required The reference ID for returning the

response.

ObjectName Required The name of the type of object to be

returned (see below)

ScopeCode Optional The scope of the query (see below).

Applies to

StudentInclusionInterventionPlan

query object only. Default value is

“Active”.

IncludeLookup

Names

Optional Code (see below) to indicate whether

or not to include SchoolName in the

returned data. Applicable only if

querying objects that optionally

include SchoolName. Defaults to

“No” if not specified.

DeptAssignedPersonId Optional The Learning ID Number of the

student whose data is to be returned

Name Optional Student’s name(s). Either the

DeptAssignedPersonId or the Name

must be included.

Type Required Name type (see below).

Name/LastName Required Last name.

Name/FirstName Required First name.

BirthDate Required The birth date of the student whose

data is to be returned (a double-check

that the right student is being queried)

ScopeCode Values

Active Include active eIIP Area of Development Outcomes and Services

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 36 of 46

Archive Include inactive (archived) eIIP Area of Development Outcomes and Services

Object Names Supported for QueryByStudent

IntensiveSupportInfo

Returns all Intensive Support information recorded for the student.

EnglishAdditionalLanguageInfo

Returns all English as an Additional Language (EAL) information recorded for the

student.

StudentInclusionInterventionPlan

Returns all Student Inclusion Intervention Plan (eIIP) information recorded for the

student.

Include Lookup Names Codes

Yes Include lookup names such as SchoolName

No Do not include lookup names such as SchoolName

Name Type Values

Legal Current legal name

Alias Alias – any current or previous name by which the individual is or was known

Examples

Request student intensive support information for a student:

<SAS_Query>

<QueryByStudent RefId=”1” ObjectName=” IntensiveSupportInfo”>

<DeptAssignedPersonId>123456789</ DeptAssignedPersonId >

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

</QueryByStudent>

</SAS_Query>

Request student English as an Additional Language (EAL) support information for a

student:

<SAS_Query>

<QueryByStudent RefId=”2” ObjectName=” EnglishAdditionalLanguageInfo”>

< DeptAssignedPersonId >123456789</ DeptAssignedPersonId >

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

</QueryByStudent>

</SAS_Query>

Request Student Inclusion Intervention Plan (eIIP) information for a student:

<SAS_Query>

<QueryByStudent RefId=”3” ObjectName=” StudentInclusionInterventionPlan”>

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 37 of 46

< DeptAssignedPersonId >123456789</ DeptAssignedPersonId >

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

</QueryByStudent>

</SAS_Query>

3.2 QueryBySchool

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

Element Attribute Status Description/Notes

QueryBySchool A request to return information for

students enrolled in a specific school.

RefId Required The reference ID for returning the

response.

ObjectName Required The name of the type of object to be

returned (see below)

ScopeCode Optional The scope of the query (see below).

Applies to

StudentInclusionInterventionPlan

query object only. Default value is

“Active”.

IncludeLookupNames Optional Code (see below) to indicate whether

or not to include SchoolName in the

returned data. Applicable only if

querying objects that optionally

include SchoolName. Defaults to

“No” if not specified.

SchoolId Required The department-assigned number of

the school whose data is to be

returned

FromDate Required The first date of the date range for

which data is to be returned (see notes

below)

ToDate Required The last date of the date range for

which data is to be returned (see notes

below)

FromGrade Optional The first grade of the grade range for

which data is to be returned (see notes

below)

Code Required Grade code (see below).

ToGrade Optional The last grade of the grade range for

which data is to be returned (see notes

below)

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 38 of 46

Code Required Grade code (see below).

ScopeCode Values

Active Include active eIIP Area of Development Outcomes and Services

Archive Include inactive (archived) eIIP Area of Development Outcomes and Services

Grade Codes

PK Pre-kindergarten (age group of 2 ½ to 5 year olds)

0K Kindergarten (4 – 7 years old)

01 Grade 1 (5 – 8 years old)

02 Grade 2 (6 – 9 years old)

03 Grade 3 (7 – 10 years old)

04 Grade 4 (8 – 11 years old)

05 Grade 5 (9 – 12 years old)

06 Grade 6 (10 – 13 years old)

07 Grade 7 (11 – 14 years old)

08 Grade 8 (12 – 15 years old)

09 Grade 9 (13 – 16 years old)

10 Grade 10 (14 – 17 years old)

11 Grade 11 (15 – 18 years old)

12 Grade 12 (16 + years old)

Object Names Supported for Query

IntensiveSupportsInfo

Returns all information for students currently enrolled.

EnglishAdditionalLanguageInfo

Returns all English as an Additional Language (EAL) information for currently

enrolled students.

StudentInclusionInterventionPlan

Returns all Student Inclusion Intervention Plan (eIIP) information recorded for

currently enrolled students.

Include Lookup Names Codes

Yes Include lookup names such as SchoolName

No Do not include lookup names such as SchoolName

Notes

If a grade range is not specified, this query returns all students enrolled in the indicated

school (as the base school or as a non-base school) any time during the date range

indicated.

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 39 of 46

If a grade range is indicated, it returns all students enrolled in the indicated school (as the

base school or as a non-base school) any time during the date range indicated, whose

most recent grade enrollment is within the grade range indicated.

For IntensiveSupportInfo and EnglishAdditionalLanguageInfo query object names, the

FromDate and ToDate must fall within the current school year.

For the StudentInclusionInterventionPlan query object name, the FromDate and ToDate

must fall within the same school year.

Examples

Request all student intensive support information for all students enrolled in a school

during a particular school year (defined by a date range):

<SAS_Query>

<QueryBySchool RefId=”1” ObjectName=” IntensiveSupportInfo”

<SchoolId>1234567</SchoolId>

<FromDate>2016-08-01</FromDate>

<ToDate>2017-07-31</ToDate>

</QueryBySchool>

</SAS_Query>

Request all Student Inclusion Intervention Plan (eIIP) information for all students

enrolled in a school during a particular school year (defined by a date range):

<SAS_Query>

<QueryBySchool RefId=”2” ObjectName=”StudentInclusionInterventionPlan”

<SchoolId>1234567</SchoolId>

<FromDate>2015-08-01</FromDate>

<ToDate>2016-07-31</ToDate>

</QueryBySchool>

</SAS_Query>

4. Message Infrastructure

Information is packaged into messages, such that one message contains one or more

objects, queries or responses.

Each message is “wrapped” in tags that define the message. The outermost tag of all

messages is SAS_Message. Within this tag is another tag identifying the type of message:

SAS_Event

SAS_Request

SAS_Response

SAS_Ping

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 40 of 46

4.1 SAS_Message

The outermost tag on all messages.

Element Attribute Status Description/Notes

SAS_Message

xmlns Required The XML namespace that defines the

specifications for this major release (see

below)

xmlns:xsi Required The XML schema instance (see below)

xsi:schemaLocation Required The physical location of the XML

schema (see below)

Version Optional The version number of the XML

specifications (currently 1.0). Defaults to

1.0 if not specified.

XML Namespace and Related Values

For this release of the Ministry of Education Student Achievement and Supports XML

specifications, use:

xmlns=”http://www.k12.gov.sk.ca/xsd/sl/1.x/SASMessage.xsd”

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

xsi:schemaLocation="http://www.k12.gov.sk.ca/xsd/sl/1.x/SASMessage.xsd

http://www.k12.gov.sk.ca/xsd/sl/1.x/SASMessage.xsd"

Example

<SAS_Message xmlns=”http://www.k12.gov.sk.ca/xsd/sl/1.x/SASMessage.xsd”

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

xsi:schemaLocation="http://www.k12.gov.sk.ca/xsd/sl/1.x/SASMessage.xsd

http://www.k12.gov.sk.ca/xsd/sl/1.x/SASMessage.xsd">

Message content goes here

</SAS_Message>

4.2 SAS_Header

Within each type of message is SAS_Header, which identifies the message and when it

was sent.

Element Attribute Status Description/Notes

SAS_Header

SAS_MsgId Required A unique identifier of the message (see note below)

SAS_Date Required The date the message was sent

SAS_Time Required The time at which the message was sent, in format

HH:MM:SS, using a 24-hour clock

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 41 of 46

Zone Optional The time zone, expressed as an offset from the zero

meridian (e.g., UTC-06:00 for Central Standard

Time). Defaults to “UTC-06:00” if not specified.

SAS_SourceId Required The unique ID of the originator of the message. This

is the department-assigned number of the

organization.

Note

SAS_MsgId has to be unique on every message sent between schools or school divisions

and the Ministry of Education. The Ministry of Education cannot accept two XML

messages with the same SAS_MsgId, even if they come from different schools.

SAS_MsgId can be any length, as long as it is unique.

Two techniques to ensure uniqueness are recommended. Schools or school divisions can

pick from either of these techniques:

Concatenate department-assigned school number, date/time, message sequence

number and user id to create a unique SAS_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 the Ministry of Education from receiving an

entire batch XML message and the message is being sent again, the SAS_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 SAS_MsgId should be used for the corrected

message.

Example

<SAS_Header>

<SAS_MsgId>12345678901234567890123456789012</SAS_MsgId>

<SAS_Date>2012-09-23</SAS_Date>

<SAS_Time Zone="UTC-06:00">20:23:54</SAS_Time>

<SAS_SourceId>8888888</SAS_SourceId>

</SAS_Header>

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 42 of 46

4.3 SAS_Event

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

Element Attribute Status Description/Notes

SAS_Event

SAS_Header Required See SAS_Header above

SAS_ObjectData Required Wrapper for the data being sent

SAS_ObjectData/

SAS_EventObject

Required and

Repeatable

Identifies the type of object being sent

and wraps the data

ObjectName Required The name of the object being sent

Action Required The action this event conveys (see

below)

Reason Optional The reason that indicates why this data

is being sent, if non-routine (see below)

SAS_ObjectData/

SAS_EventObjec

t/ objectname

Required and

Repeatable

The actual data being sent (see object

specifications above)

Event Action Values

Add

Change

4.4 SAS_Request

A request message asks for data to be returned.

Element Attribute Status Description/Notes

SAS_Request

SAS_Header Required See SAS_Header above

SAS_Query Required The query for data. See SAS_Query

under Queries.

SAS_Query/

objectname

Required and

Repeatable

The actual queries, which can be any

query in section 3.

Example

<SAS_Message xmlns=”http://www.k12.gov.sk.ca/xsd/sl/1.x/SASMessage.xsd”

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

xsi:schemaLocation="http://www.k12.gov.sk.ca/xsd/sl/1.x/SASMessage.xsd

http://www.k12.gov.sk.ca/xsd/sl/1.x/SASMessage.xsd">

<SAS_Request>

<SAS_Header>

<SAS_MsgId>12345678901234567890123456789012</SAS_MsgId>

<SAS_Date>2012-09-16</SAS_Date>

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 43 of 46

<SAS_Time Zone="UTC-06:00">20:23:54</SAS_Time>

<SAS_SourceId>1234567</SAS_SourceId>

</SAS_Header>

<SAS_Query>

<GeneralQuery RefId=”1” ObjectName=”IntensiveSupportInfo”>

</GeneralQuery>

</SAS_Query>

</SAS_Request>

</SAS_Message>

4.5 SAS_Response

A response message acknowledges an event or request, indicates whether or not it could

be successfully processed and sends data back if applicable.

Element Attribute Status Description/Notes

SAS_Response

SAS_Header Required See SAS_Header above

SAS_Ack Required Acknowledgement of the message that

elicited this response

SAS_Ack/

SAS_OriginalMsgId

Required The message ID of the message that

elicited this response

SAS_Ack/

SAS_OriginalSource Id

Required The unique ID of the originator of the

message that elicited this response

SAS_Ack/SAS_Status Required Whether or not the original message

was successfully processed

SAS_Ack/SAS_Status

/ SAS_StatusCode

Required Status code (see below)

SAS_Ack/SAS_Status

/ SAS_StatusMsg

Optional Message if required to clarify the status

SAS_Ack/SAS_Error Optional

and

Repeatable

Exception message

ObjectNam

e

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

SAS_Ack/SAS_Error/

SAS_ErrorSeverity

Required Message severity (see below)

SAS_Ack/SAS_Error/

SAS_ErrorCode

Required Error code (values published separately)

SAS_Ack/SAS_Error/

SAS_ErrorMsg

Optional Message describing the error

SAS_ObjectData Optional Wrapper for any data being returned

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 44 of 46

SAS_ObjectData/

SAS_EventObject

Required

and

Repeatable

Identifies the type of object being

returned and wraps the data

ObjectNam

e

Required The name of the object being returned

Action Required Will be set to “None”

Reason Optional Not applicable

SAS_ObjectData/

SAS_EventObject/

objectname

Required

and

Repeatable

The actual data being returned (see

object specifications above)

Status Code Values

Successful Processed successfully, no messages or only informational messages

Warnings Processed successfully with warning messages

Errors Processed with error messages

Invalid Invalid XML

Message Severity Values

Informational

Warning

Error

4.6 SAS_Ping

The ping message allows an institution to determine whether the system it wants to send

messages to is receiving messages.

Element Attribute Status Description/Notes

SAS_Ping Required Request to acknowledge the ping

SAS_Header Required See SAS_Header above

Example

<SAS_Message xmlns=”http://www.k12.gov.sk.ca/xsd/sl/1.x/SASMessage.xsd”

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

xsi:schemaLocation="http://www.k12.gov.sk.ca/xsd/sl/1.x/SASMessage.xsd

http://www.k12.gov.sk.ca/xsd/sl/1.x/SASMessage.xsd">

<SAS_Ping>

<SAS_Header>

<SAS_MsgId>12345678901234567890123456789012</SAS_MsgId>

<SAS_Date>2009-09-23</SAS_Date>

<SAS_Time Zone="UTC-06:00">20:23:54</SAS_Time>

<SAS_SourceId>1234567</SAS_SourceId>

</SAS_Header>

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 45 of 46

</SAS_Ping>

</SAS_Message>

Ministry of Education Student Achievement and Supports XML Specifications

Updated January 2017

Page 46 of 46

Appendix A – Additional Edits

Additional Edits Revision History

Date Version Changes 2013 Mar 15 Pre-release

2015 July 16 1.4 Removed requirement that SchoolId has to match SourceId

when submitting ProvincialAssessmentInfo object.

The following rules indicate edits Student Achievement and Supports 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 or school

division (to indicate both the cause of the problem and the action taken by the system).

SchoolId

XML Message/system action

SchoolId 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). Does not apply to the

ProvincialAssessmentInfo object.

SAS_Query

XML Message/system action

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

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.