The introduction for the SIF AU data model.
This object defines information related to a school calendar day in a given school calendar year. If both CalendarDate and CalendarSummary objects are supported, there must be an instance of this object for each date between CalendarSummary StartDate and EndDate, inclusive.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||||||
---|---|---|---|---|---|---|---|---|---|---|
CalendarDate | This object defines information related to a school calendar day in a given school calendar year. If both CalendarDate and CalendarSummary objects are supported, there must be an instance of this object for each date between CalendarSummary StartDate and EndDate, inclusive. | |||||||||
@ | Date | M | A specific school day that occurs within the school year. | xs:date | ||||||
@ | CalendarSummaryRefId | M | The ID (GUID) of the calendar summary in which this calendar date is. | IdRefType | ||||||
SchoolInfoRefId | M | The ID (GUID) of the school for which this calendar information is being reported. | IdRefType | |||||||
SchoolYear | M | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2009"). | SchoolYear | |||||||
CalendarDateType | M | Calendar date type information. | ||||||||
CalendarDateType/Code | M | Code indicating the type of school day. | AUCodeSetsCalendarEventType | |||||||
StudentAttendance | O | Information describing how the day relates to student attendance. | ||||||||
StudentAttendance/CountsTowardAttendance | M | Designates whether this date should be counted toward student attendance. | values:
| |||||||
StudentAttendance/AttendanceValue | M |
Amount of the school day in which the student should be in attendance (Format is x.x; a student who should be in attendance a full day would be represented as 1.0). If | xs:decimal
| |||||||
SIF_Metadata | O | SIF_Metadata | ||||||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object provides a summary of a school's calendar information for a given school year. A school may have more than one calendar per school year (e.g., one calendar for Kindergarten students, one for special education students, one for seniors, or one for each calendar track), and each may have different days in session, start and end dates, minutes per day, instructional minutes, etc.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
CalendarSummary | This object provides a summary of a school's calendar information for a given school year. A school may have more than one calendar per school year (e.g., one calendar for Kindergarten students, one for special education students, one for seniors, or one for each calendar track), and each may have different days in session, start and end dates, minutes per day, instructional minutes, etc. | |||
@ | RefId | M | The ID (GUID) of the calendar to which this information relates. | RefIdType |
SchoolInfoRefId | M | The ID (GUID) of the school for which this calendar information is being reported. | IdRefType | |
SchoolYear | M | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007"). | SchoolYear | |
LocalId | M | The locally assigned identifier for this calendar. | LocalId | |
Description | O | Textual description of the school calendar. | xs:string | |
DaysInSession | M | The total number of days that the school was or is anticipated to be in session during the school year. Also included are days on which the education institution facility is closed and the student body as a whole is engaged in planned activities off-campus under the guidance and direction of staff members. | xs:unsignedInt | |
StartDate | O | The first calendar date, whether or not instruction was provided. If both CalendarSummary and CalendarDate objects are supported, StartDate must be the date of the first chronological instance of CalendarDate for the school's calendar. | xs:date | |
EndDate | O | The last calendar date, whether or not instruction was provided. If both CalendarSummary and CalendarDate objects are supported, EndDate must be the last chronological instance of CalendarDate for the school's calendar. | xs:date | |
FirstInstructionDate | O | The first day of student instruction. | xs:date | |
LastInstructionDate | O | The last day of student instruction (including days or times that students are present for purposes of testing and/or evaluation, but not including whole or part-days whose sole purposes is for distribution of report cards). | xs:date | |
GraduationDate | O | Date of graduation ceremony. | GraduationDate | |
InstructionalMinutes | O | The total number of instructional minutes for this calendar for the school year. | xs:unsignedInt | |
MinutesPerDay | O | The number of minutes in the day in which the school is normally in session. | xs:unsignedInt | |
YearLevels | O | Collection of year levels applicable to this school calendar. | YearLevels | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object allows a system that stores network identities and/or passwords to share them with other applications through SIF. The provider of the Identity
object may only support providing an identity or a password, or it may support both.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
Identity |
This object allows a system that stores network identities and/or passwords to share them with other applications through SIF. The provider of the | |||
@ | RefId | M | The SIF RefId that uniquely identifies this object. | RefIdType |
SIF_RefId | M | The SIF RefId of a StudentPersonal, StaffPersonal, or StudentContactPersonal object. | IdRefType | |
@ | SIF_RefObject | M |
The type of SIF object that the | values:
|
AuthenticationSource | M |
The type of source system that produced this See implementation notes for provider requirements. | values:
| |
IdentityAssertions | O | The list of identity assertions for this user. | ActionList (IdentityAssertion/@SchemaName) | |
IdentityAssertions/IdentityAssertion | MR | The identification string for this user. | xs:normalizedString | |
@ | SchemaName | M | The name of the field. See implementation notes for details on required schema elements. Examples | xs:normalizedString |
PasswordList | O | Allows a provider or publisher to specify the same password using multiple algorithms, if supported. | List | |
PasswordList/Password | MR | A representation of the user's password using the given algorithm. | xs:base64Binary | |
@ | Algorithm | M | The method used to encrypt the user's password. See the implementation details below. | values:
|
@ | KeyName | M | The name of the key to be used for decryption of the password. Left blank for hash algorithms (MD5 and SHA1). | xs:normalizedString |
AuthenticationSourceGlobalUID | O | The globally unique person identifier that links together separate Identity objects which reference the same Person. | IdRefType | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object contains information about a school district or other Local Educational Agency (LEA).
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
LEAInfo | This object contains information about a school district or other Local Educational Agency (LEA). | |||
@ | RefId | M | The GUID of the LEA whose information this is. | RefIdType |
LocalId | M | The locally-assigned identifier for this LEA. | LocalId | |
StateProvinceId | O | The state-assigned identifier for this LEA. | StateProvinceId | |
CommonwealthId | O | Commonwealth Identifier for this District (LEA). | xs:normalizedString | |
LEAName | M | Name of LEA. | xs:normalizedString | |
LEAURL | O | URL for the LEA. | xs:anyURI | |
EducationAgencyType | O | The classification of the education agency within the geographic boundaries of a state according to the level of administrative and operational control. | ||
EducationAgencyType/Code | M | Code indicating the operational/administrative level. | AUCodeSetsEducationAgencyTypeType | |
EducationAgencyType/OtherCodeList | O | OtherCodeList | ||
LEAContactList | O | List | ||
LEAContactList/LEAContact | MR | Information on contact persons for this LEA. | ||
LEAContactList/LEAContact/ PublishInDirectory | O | Indicates whether or not this LEA contact's information should be published in a directory of LEA information. | PublishInDirectory | |
LEAContactList/LEAContact/ ContactInfo | M | ContactInfo | ||
PhoneNumberList | O | The LEA's phone number(s). | PhoneNumberList | |
AddressList | O | The LEA's address(es). | AddressList | |
OperationalStatus | O | Operational condition of a school. | OperationalStatus | |
JurisdictionLowerHouse | O | Lower House area that the school/campus belongs to. | xs:normalizedString | |
SLA | O | Statistical Local Area that the school/campus belongs to. | AUCodeSetsAustralianStandardGeographicalClassificationASGCType | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object contains information about the person's picture.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
PersonPicture | This object contains information about the person's picture. | |||
@ | RefId | M | The ID (GUID) that uniquely identifies the picture. | IdRefType |
ParentObjectRefId | M | The GUID of the personal object to which this picture is linked | RefIdType | |
@ | SIF_RefObject | M | The name of the object reference. | values:
|
SchoolYear | M |
School year for which this enrollment is applicable, expressed as the four-digit year in which the school year
ends (e.g. | SchoolYear | |
PictureSource | M | This element defines the picture. If the Type attribute is URL, this is the location of the picture in [JPEG] format; if Type is JPEG, this is the [JPEG] image data encoded using the Base64 Content-Transfer-Encoding defined in Section 6.8 of [RFC 2045]. | URIOrBinaryType | |
@ | Type | M | The way the picture is specified. | AUCodeSetsPictureSourceType |
OKToPublish | O | Can the picture be published? | AUCodeSetsYesOrNoCategoryType | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object contains information on authorities that provide ReportManifest objects and/or collect SIF_ReportObject objects, such as state departments of education, regional service agencies, or other report collecting agencies.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
ReportAuthorityInfo | This object contains information on authorities that provide ReportManifest objects and/or collect SIF_ReportObject objects, such as state departments of education, regional service agencies, or other report collecting agencies. | |||
@ | RefId | M | The unique identifier for this agency/report authority. | RefIdType |
AuthorityName | M | Name of the agency/report authority. | xs:normalizedString | |
AuthorityId | M | The zone unique case-sensitive identifier for the authority. This will be the contents of the SIF_SourceId element in the header of requests for reports. | xs:token | |
AuthorityDepartment | O | Department, office, or subdivision of the agency/report authority. | xs:normalizedString | |
AuthorityLevel | M | Level of the authority. | values:
| |
ContactInfo | O | Information on the contact person in this agency. | ContactInfo | |
Address | O | Address | ||
PhoneNumber | O | PhoneNumber | ||
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object provides a way to define a report within a SIF zone. It contains metadata about the report. This object represents a mutual agreement between senders and receivers of the report.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
ReportManifest | This object provides a way to define a report within a SIF zone. It contains metadata about the report. This object represents a mutual agreement between senders and receivers of the report. | |||
@ | RefId | M | The unique identifier for this report manifest. | RefIdType |
@ | ReportAuthorityInfoRefId | M | ID (GUID) of the authority providing this manifest. | IdRefType |
SIF_Version | M |
Specifies which SIF Implementation Specification version should be used when returning the report data; wildcards are allowed. When a wildcard is specified,
the responding agent SHOULD attempt to return the report data in the version specified by | VersionWithWildcardsType | |
SIF_MaxBufferSize | M | Specifies the maximum size of a packet to be returned to the report authority. | xs:unsignedInt | |
ReceivingAuthority | O | The GUID of the authority for whom the report is intended, usually the same authority that defines this manifest. | IdRefType | |
@ | SIF_RefObject | M | The name of the object referenced. | values:
|
ReportName | M | The authority's accepted name for the report. | xs:normalizedString | |
Description | O | The description for the report. | xs:string | |
ReportingPeriod | O | Information on the period of time over which the report spans. | ||
ReportingPeriod/BeginReportDate | O | The first date for which the report contains information. | xs:date | |
ReportingPeriod/EndReportDate | O | The last date for which the report contains information. May be the same as BeginReportDate for snapshot-type reports. | xs:date | |
ReportingPeriod/BeginSubmitDate | O | The first date on which the report may be submitted to the authority. | xs:date | |
ReportingPeriod/EndSubmitDate | O | The last date on which the report may be submitted to the authority. | xs:date | |
ReportingPeriod/DueDate | O | The official due date of the report. | xs:date | |
ReportDefinitionSource | M |
Indicates where the report definition can be found.
If Type is | xs:string | |
@ | Type | M | This attribute indicates the source of the report definition. | values:
|
@ | QueryLanguage | M |
The vendor-defined query language used in the report definition (e.g. | xs:token |
ReportFormatList | O | An optional list of one or more third-party formats that describe the visual representation of the report data. If more than one report format is associated with a manifest, the implementation can choose the most applicable format by examining the ContentType attribute. | List | |
ReportFormatList/ReportFormat | MR | A third-party format that describes the visual representation of the report data. | xs:string | |
@ | Type | M | This attribute indicates the encoding of the format reference. | values:
|
@ | ContentType | M |
The vendor-defined content type (e.g. | xs:normalizedString |
SIF_QueryGroup | C |
Parent element containing the querying criteria for extracting the report information if | List | |
SIF_QueryGroup/SIF_Query | MR | SIF_Query | ||
SIF_ExtendedQuery | C |
Query criteria for extracting the report information if | SIF_ExtendedQuery | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object contains all of the information about a school's room. This object may contain a reference to a room type so that it may represent anything from a gym, cafeteria, to a standard classroom. The StaffList element usually contains the homeroom teacher.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
RoomInfo | This object contains all of the information about a school's room. This object may contain a reference to a room type so that it may represent anything from a gym, cafeteria, to a standard classroom. The StaffList element usually contains the homeroom teacher. | |||
@ | RefId | M | GUID that identifies this room. | RefIdType |
SchoolInfoRefId | M | GUID that identifies the school that this room belongs to. | IdRefType | |
RoomNumber | M | Room number as presented to the user/application. | xs:normalizedString | |
StaffList | O | List | ||
StaffList/StaffPersonalRefId | MR | GUID that identifies the staff person assigned to this room (e.g. the homeroom teacher). | IdRefType | |
Description | O |
Friendly name that can be assigned to the room (e.g. | xs:normalizedString | |
Building | O | Extra building information. In the future Building could become its own object in which case this element will need to be changed to a RefId. Currently it is only required as a free text field. | xs:normalizedString | |
HomeroomNumber | O | When a room is designated as a homeroom it may have a different number. Usually blank when room is not a homeroom. | xs:normalizedString | |
Size | O | Size in square meters. | xs:decimal | |
Capacity | O | Number of persons (usually students) that this room can hold. | xs:unsignedInt | |
PhoneNumber | O | Phone number for the room | PhoneNumber | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object is for course information.
All local ids in non-authoritative objects are optional. It is therefore up to the provider and the actual agent's design and choreography to determine whether or not to use or local ids from parent objects. There are cases in some subscribing systems where it might not possible to add RefId columns and therefore the RefId of related objects cannot be stored. For example a target system that listens to TimeTableSubject events and updates them may not be able to store the associated SchoolCourseInfoRefId with that object. The only way it can link the TimeTableSubject object with the appropriate course might be through its local course id. Having local ids that link the parent objects with the child object can simplify the agent design. Generally it is suggested to use the appropriate RefIds whenever possible and only use local ids if there is no other way to use RefIds.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SchoolCourseInfo | This object is for course information. All local ids in non-authoritative objects are optional. It is therefore up to the provider and the actual agent's design and choreography to determine whether or not to use or local ids from parent objects. There are cases in some subscribing systems where it might not possible to add RefId columns and therefore the RefId of related objects cannot be stored. For example a target system that listens to TimeTableSubject events and updates them may not be able to store the associated SchoolCourseInfoRefId with that object. The only way it can link the TimeTableSubject object with the appropriate course might be through its local course id. Having local ids that link the parent objects with the child object can simplify the agent design. Generally it is suggested to use the appropriate RefIds whenever possible and only use local ids if there is no other way to use RefIds. | |||
@ | RefId | M | The ID (GUID) that uniquely identifies the school course. | RefIdType |
SchoolInfoRefId | M | The ID (GUID) that identifies the school where the course is offered. | IdRefType | |
SchoolLocalId | O | The locally-assigned identifier for this school/campus. | LocalId | |
SchoolYear | C |
School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g. | SchoolYear | |
TermInfoRefId | C | The ID (GUID) that uniquely identifies this TermInfo (reportable time period). Either SchoolYear or TermInfoRefId must be provided. | IdRefType | |
CourseCode | M | School-defined local code for the course. | xs:normalizedString | |
StateCourseCode | O | State-defined standard course code used to report information about courses. | xs:normalizedString | |
DistrictCourseCode | O | The corresponding district course code. | xs:normalizedString | |
SubjectAreaList | O | Subject matter areas. | SubjectAreaList | |
CourseTitle | M | Title of the course. | xs:normalizedString | |
Description | O | Textual description of the course. | xs:normalizedString | |
InstructionalLevel | O | An indication of the general nature and difficulty of instruction provided. | xs:normalizedString | |
CourseCredits | O | The number of credits awarded upon course completion. | xs:normalizedString | |
CoreAcademicCourse | O | Does the course meet the state definition of a core academic course? | AUCodeSetsYesOrNoCategoryType | |
GraduationRequirement | O | Does the state require that the course be completed for graduation? | AUCodeSetsYesOrNoCategoryType | |
Department | O | Department with jurisdiction over this course. | xs:normalizedString | |
CourseContent | O | Description of course content. | xs:normalizedString | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object contains information about the school.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SchoolInfo | This object contains information about the school. | |||
@ | RefId | M | The GUID that identifies this school. | RefIdType |
LocalId | O | The locally-assigned identifier for this school. | LocalId | |
StateProvinceId | O | The state-assigned identifier for this school. | StateProvinceId | |
CommonwealthId | O | Commonwealth identifier for this school/campus. | xs:normalizedString | |
SchoolName | M | Name of school/campus. | xs:normalizedString | |
LEAInfoRefId | O | The ID (GUID) that references the school district of which this school is a member. | RefIdType | |
OtherLEA | O | The ID (GUID) of another related education agency, such as a regional service agency. | RefIdType | |
@ | SIF_RefObject | M | The name of the object reference. | values:
|
SchoolDistrict | O | The school district of which this school/campus is a member. Equivalent to DEECD Region. | xs:normalizedString | |
SchoolDistrictLocalId | O | The school district Local ID. This should be the same as the LocalId in the LEAInfo if LEAInfo details are supplied. | LocalId | |
SchoolType | O | An indication of the level of the educational institution. | AUCodeSetsSchoolLevelType | |
SchoolFocusList | O | List containing the education focus codes of the campus/school. | List | |
SchoolFocusList/SchoolFocus | MR | The type of educational institution as classified by its focus. | AUCodeSetsSchoolFocusCodeType | |
SchoolURL | O | URL for the school. | SchoolURL | |
PrincipalInfo | O | Information about the campus or school principal. | PrincipalInfo | |
SchoolContactList | O | A list of contact persons associated with a school. | SchoolContactList | |
AddressList | O | The school's addresses. | AddressList | |
PhoneNumberList | O | The school's phone numbers. | PhoneNumberList | |
SessionType | O | Code that specifies the session type. | AUCodeSetsSessionTypeType | |
YearLevels | O | List of year levels offered by the school. | YearLevels | |
ARIA | O | Accessibility/Remoteness Indicator of Australia. | xs:decimal | |
OperationalStatus | O | Operational condition of a school. | OperationalStatus | |
FederalElectorate | O | Australian Federal Electorate. | AUCodeSetsFederalElectorateType | |
Campus | O | Optional campus details. | ||
Campus/SchoolCampusId | M | Campus ID - Needs to be considered as part of school. Different campus' have different addresses. | xs:normalizedString | |
Campus/CampusType | O | Type of campus. | AUCodeSetsSchoolLevelType | |
Campus/AdminStatus | M | Is this campus the Admin Campus? | AUCodeSetsYesOrNoCategoryType | |
SchoolSector | M | (Government, or Non-Government). | AUCodeSetsSchoolSectorCodeType | |
IndependentSchool | O | Indicator as to whether school is an independent school (as opposed to government or catholic school). | AUCodeSetsYesOrNoCategoryType | |
NonGovSystemicStatus | O | Used to clarify a non-government school's systemic status. Either Systemic or Non-Systemic. | AUCodeSetsSystemicStatusType | |
System | O | System if a systemic school. | AUCodeSetsSchoolSystemType | |
ReligiousAffiliation | O | Religious affiliation (if any). | AUCodeSetsAustralianStandardClassificationOfReligiousGroupsASCRGType | |
SchoolGeographicLocation | O | School Location from MCEETCYA. | AUCodeSetsSchoolLocationType | |
LocalGovernmentArea | O | LocalGovernmentArea that that school/campus is located in. | xs:normalizedString | |
JurisdictionLowerHouse | O | Lower House area that the school/campus belongs to. | xs:normalizedString | |
SLA | O | Statistical Local Area that the school/campus belongs to. | AUCodeSetsAustralianStandardGeographicalClassificationASGCType | |
SchoolCoEdStatus | O | Gender of student population. | AUCodeSetsSchoolCoEdStatusType | |
BoardingSchoolStatus | O | Is this school a Boarding School? | AUCodeSetsYesOrNoCategoryType | |
Entity_Open | O | Opening date of entity. | xs:date | |
Entity_Close | O | Closing date of entity. This element is allowed to be omitted and/or null. | xs:date | |
SchoolGroupList | O | List | ||
SchoolGroupList/SchoolGroup | MR | Repeatable element containing a local identifier to identify a loosely connected group of schools. eg. YarraValley Cluster | LocalId | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SchoolPrograms | This object contains information about Programs offered by a school. | |||
@ | RefId | M | GUID that uniquely identifies this instance of the object. | RefIdType |
SchoolInfoRefId | M | GUID that identifies the school offering this program. | IdRefType | |
SchoolYear | O | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2009"). | SchoolYear | |
SchoolProgramList | O | List of School Programs | List | |
SchoolProgramList/Program | OR | |||
SchoolProgramList/Program/ Category | O | Program Category | xs:normalizedString | |
SchoolProgramList/Program/ Type | M | Program Type | xs:normalizedString | |
SchoolProgramList/Program/ OtherCodeList | O | OtherCodeList | ||
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object provides the link between Period Attendance and the school�s timetable. It allows subject and teaching group information to be communicated to/from the attendance system.
This object provides information about the session�the specific instance of a timetable cell for against which the attendance is recorded. (Please note, the TimeTableCell object represents a session scheduled in a timetable. There may be many SessionInfo objects for the same TimeTableCell � each for a different week/fortnight, depending on the length of the timetable schedule. Attendance is recorded against the SessionInfo object.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SessionInfo | This object provides the link between Period Attendance and the school�s timetable. It allows subject and teaching group information to be communicated to/from the attendance system. This object provides information about the session�the specific instance of a timetable cell for against which the attendance is recorded. (Please note, the TimeTableCell object represents a session scheduled in a timetable. There may be many SessionInfo objects for the same TimeTableCell � each for a different week/fortnight, depending on the length of the timetable schedule. Attendance is recorded against the SessionInfo object. | |||
@ | RefId | M | The GUID of the Object | RefIdType |
SchoolInfoRefId | M | The ID (GUID) of the school for which this attendance information is being reported. | IdRefType | |
TimeTableCellRefId | M | The (GUID) of the piece of Curriculum (TT Grid) scheduled | IdRefType | |
SchoolYear | M | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007"). | SchoolYear | |
LocalId | M | Session Local Identifier | LocalId | |
TimeTableSubjectLocalId | M | TimeTableSubject Local Identifier | LocalId | |
TeachingGroupLocalId | M | Teaching Group Local Identifier | LocalId | |
SchoolLocalId | O | School Local Identifier | LocalId | |
StaffPersonalLocalId | O | Staff Local Identifier | LocalId | |
RoomNumber | C | Room number as presented to the user or application. Needs to be provided if changed from TimeTableCell. | xs:normalizedString | |
DayId | M | Day Id | LocalId | |
PeriodId | M | Period Id within the Day Id | LocalId | |
SessionDate | M | Date of Session | xs:date | |
StartTime | O | Optional Start Time | xs:time | |
FinishTime | O | Optional End Time | xs:time | |
RollMarked | O | Was the Roll Marked for this Period? | AUCodeSetsYesOrNoCategoryType | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object is an envelope used to send other data objects, typically reports, to authorities such as state departments of education, district offices, other schools, etc. It is also used to signal a data collector agent that a report is compiled and ready to be requested. SIF_ReportObject contains a data object, which is either complete or partial (a partial data object is one that contains a subset of the elements for the data object). One or a series of SIF_ReportObjects contained within one or a series of related SIF_Response messages makes up a complete report.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SIF_ReportObject | This object is an envelope used to send other data objects, typically reports, to authorities such as state departments of education, district offices, other schools, etc. It is also used to signal a data collector agent that a report is compiled and ready to be requested. SIF_ReportObject contains a data object, which is either complete or partial (a partial data object is one that contains a subset of the elements for the data object). One or a series of SIF_ReportObjects contained within one or a series of related SIF_Response messages makes up a complete report. | |||
@ | RefId | M | The ID (GUID) that uniquely identifies this instance of a report. | RefIdType |
ReportInfo | C | Identifies the manifest for the report and characteristics of the submission. This element is a conditional element. This element, the ReportData element, or the SIF_ExtendedQueryResults element is included but never more than one at the same time within an instance of this object. See examples of the usage of the object below. | ||
@ | ReportManifestRefId | M | The report manifest corresponding to this report. | IdRefType |
ReportInfo/CalculationDate | M | The date on which the report was calculated. | xs:date | |
ReportInfo/SubmissionNumber | M | A number that identifies the submission; beginning at 1 and incremented each time a submission is done for a particular report; used to indicate resubmission(s). | xs:positiveInteger | |
ReportInfo/SubmissionReason | M | Reason for the report submission. | values:
| |
ReportInfo/ReportSubmitterInfo | C | Identifies the submitter of the report. This element is conditional depending on the context in which the SIF_ReportObject is used. It must be present in the ReportInfo element when a SIF_ReportObject is sent to a report authority in a SIF_Event message. However, its presence is optional in SIF_ReportObject packets delivered to report authorities in SIF_Response messages. | ||
ReportInfo/ReportSubmitterInfo/ SIF_RefId | O | If the submitter is described by another SIF data object such as a SchoolInfo or LEAInfo instance, this element references that object by RefId. | IdRefType | |
@ | SIF_RefObject | M | The name of a SIF data object. When used in the context of ReportSubmitterInfo, this attribute must have one of the following values. | values:
|
ReportInfo/ReportSubmitterInfo/ SubmitterName | M | Name of the report submitter. This is a descriptive string that names the entity submitting the SIF_ReportObject to the report authority. It could be the name of an agency, a district, a school, the SIF_SourceId of the submitting agent, or any other string that a report authority could use to identify the submitter of a report. This element may be present regardless of the presence of the SIF_RefId and SIF_RefObject elements. When those elements are used, it is recommended that collector agents reproduce the name of the LEA or school here. | xs:normalizedString | |
ReportInfo/ReportSubmitterInfo/ SubmitterDepartment | O | Department, office, or subdivision of the agency submitting the report. | xs:normalizedString | |
ReportInfo/ReportSubmitterInfo/ ContactInfo | O | Information on the contact person in this agency submitting the report. | ContactInfo | |
ReportInfo/ReportSubmitterInfo/ Address | O | Address | ||
ReportInfo/ReportSubmitterInfo/ PhoneNumber | O | PhoneNumber | ||
ReportInfo/ReportSubmitterInfo/ SubmitterNotes | O | Optional notes for the report authority, such as information about a district's reporting policies and procedures, instructions for contacting the district for technical support, etc. | xs:string | |
ReportInfo/Description | O | xs:string | ||
ReportData | C |
Container element for the report content; one valid SIF object can occur as a child here. This element is conditional.
This element or | ReportDataObjectType | |
SIF_ExtendedQueryResults | C |
The report content resulting from a | SIF_ExtendedQueryResults | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object defines information related to a staff member's assignment(s); commonly, this will be a school assignment.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||||||
---|---|---|---|---|---|---|---|---|---|---|
StaffAssignment | This object defines information related to a staff member's assignment(s); commonly, this will be a school assignment. | |||||||||
@ | RefId | M | The GUID that uniquely identifies a particular staff assignment. | RefIdType | ||||||
SchoolInfoRefId | M | The ID (GUID) that identifies the school where the staff member is assigned. | IdRefType | |||||||
SchoolYear | M |
School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., | SchoolYear | |||||||
StaffPersonalRefId | M | ID (GUID) of this staff member, as represented in the StaffPersonal object. | IdRefType | |||||||
Description | O | Short assignment description | xs:normalizedString | |||||||
PrimaryAssignment | M |
Is this the staff member's primary assignment? Note: There must be one and only one instance of the object with a | AUCodeSetsYesOrNoCategoryType | |||||||
JobStartDate | O | This is the date from which the staff assignment is valid (inclusive). | xs:date | |||||||
JobEndDate | O | This is the date through which the staff assignment is valid (inclusive). | xs:date | |||||||
JobFTE | O | Full-time job equivalent ratio for this assignment. (Format is x.xx; an employee who is full-time and who is 50% of their time on this assignment would be represented as 0.50) | xs:decimal
| |||||||
JobFunction | O | The purpose of the activities as related to students. | xs:string | |||||||
StaffSubjectList | O | Subject(s) Staff member is eligible to teach. | List | |||||||
StaffSubjectList/StaffSubject | MR | This element contains Staff subjects they are eligible to teach together with the teaching preference. | ||||||||
StaffSubjectList/StaffSubject/ PreferenceNumber | M | Priority of Subject to Teach. | xs:unsignedInt | |||||||
StaffSubjectList/StaffSubject/ SubjectLocalId | O | Local Subject Id | LocalId | |||||||
StaffSubjectList/StaffSubject/ TimeTableSubjectRefId | O | RefId of TimeTableSubject | RefIdType | |||||||
YearLevels | O | Year level(s) that the teacher is allowed to teach. | YearLevels | |||||||
CasualReliefTeacher | O | Is this teacher a casual relief teacher CRT? | AUCodeSetsYesOrNoCategoryType | |||||||
Homegroup | O | The name of the homegroup the staff member is assigned to. | xs:normalizedString | |||||||
House | O | The name of the house the staff member is assigned to. | xs:normalizedString | |||||||
SIF_Metadata | O | SIF_Metadata | ||||||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object contains all the personal information relating to a staff member, who might be a teacher or other employee of the school or district.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
StaffPersonal | This object contains all the personal information relating to a staff member, who might be a teacher or other employee of the school or district. | |||
@ | RefId | M | The GUID of the staff member. | RefIdType |
LocalId | M | The locally-assigned identifier for this staff member. | LocalId | |
StateProvinceId | O | The state-assigned identifier for this staff member. | StateProvinceId | |
ElectronicIdList | O | Electronic identifier(s) associated with this entity. | ElectronicIdList | |
OtherIdList | O | Lists all "other" identifiers associated with the staff member. | List | |
OtherIdList/OtherId | MR | Lists an "other" identifier associated with the staff member. | xs:normalizedString | |
@ | Type | M | Code that defines the type of this other ID. | xs:normalizedString |
PersonInfo | M | Personal Information | PersonInfo | |
Title | O | The staff member's title. | xs:normalizedString | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
Co-curricular or extra-curricular activities (e.g., student organizations, inter-school sports, athletics, publications, band, orchestra, and service activities) in which students may participate.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
StudentActivityInfo | Co-curricular or extra-curricular activities (e.g., student organizations, inter-school sports, athletics, publications, band, orchestra, and service activities) in which students may participate. | |||
@ | RefId | M | The ID (GUID) that uniquely identifies the instance of the object. | RefIdType |
Title | M | Name of the co-curricular or extra-curricular activity. | xs:normalizedString | |
Description | O | The description of the co-curricular or extra-curricular activity. | xs:normalizedString | |
StudentActivityType | M | Information regarding the co-curricular or extra-curricular activity. | ||
StudentActivityType/Code | M | Code identifying the co-curricular or extra-curricular activity. | AUCodeSetsActivityInvolvementCodeType | |
StudentActivityType/OtherCodeList | O | OtherCodeList | ||
StudentActivityLevel | O | A description of the separation of level in the activity (e.g.,House, Inter-school, Club, State, National). | xs:normalizedString | |
YearLevels | O | Collection of grade levels applicable to this co-curricular or extra-curricular activity. | YearLevels | |
CurricularStatus | O | An indication of the degree to which an activity is related to a student's curriculum. | AUCodeSetsActivityTypeType | |
Location | O | Location where the activity takes place. | Location | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
StudentActivityParticipation | This object provides information on a co-curricular or extra-curricular activity in which a student participates during a given school year. | |||
@ | RefId | M | The ID (GUID) that uniquely identifies the instance of the object. | RefIdType |
StudentPersonalRefId | M | GUID that identifies the student participating in the activity. | IdRefType | |
StudentActivityInfoRefId | M | GUID that identifies the activity in which the student participates. | IdRefType | |
SchoolYear | O | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2009"). | SchoolYear | |
ParticipationComment | O | Comment related to the student's participation in the activity. | xs:string | |
StartDate | O | This is the date which the activity participation is valid (inclusive). | xs:date | |
EndDate | O | This is the date through which the activity participation is valid (inclusive). If element is supported by the publisher/responder, should contain a date if the student withdraws from the activity before the end of the school year. | xs:date | |
Role | O | Specific role the student plays in the activity (e.g., band leader, student body president). | xs:normalizedString | |
RecognitionList | O | List of awards and other types of recognition given to the student for this activity. | List | |
RecognitionList/Recognition | MR | The nature of recognition given to the student for the successful completion of work in a co-curricular or extra-curricular activity. | xs:normalizedString | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object provides a summary of a student's daily attendance and membership information for a given school during the time period between the StartDate and EndDate, inclusive. As such, there may be multiple instances of this object for a student in a school over the course of a school year.
SIF_Events are not reported for this object.
Element/@Attribute | Char | Description | Type | |||||||
---|---|---|---|---|---|---|---|---|---|---|
StudentAttendanceSummary | This object provides a summary of a student's daily attendance and membership information for a given school during the time period between the StartDate and EndDate, inclusive. As such, there may be multiple instances of this object for a student in a school over the course of a school year. | |||||||||
@ | StudentPersonalRefId | M | The ID (GUID) of the student for whom this attendance information is being reported. | IdRefType | ||||||
@ | SchoolInfoRefId | M | The ID (GUID) of the school for which this attendance information is being reported. | IdRefType | ||||||
@ | SchoolYear | M | School year for which the information is applicable. | SchoolYear | ||||||
@ | StartDate | M | Starting date of this attendance reporting period. | xs:date | ||||||
@ | EndDate | M | Ending date of this attendance reporting period. | xs:date | ||||||
StartDay | O | Number of the school day represented in StartDate. | xs:unsignedInt | |||||||
EndDay | O | Number of the school day represented in EndDate. | xs:unsignedInt | |||||||
FTE | O | Full time equivalent numeric value of the student's course load during this attendance period, expressed in decimal form, where 1.00 represents a full time enrollment. | xs:decimal
| |||||||
DaysAttended | M | The number of days the student attended school when school was in session between the StartDate and EndDate, inclusive. | xs:decimal | |||||||
ExcusedAbsences | M | The number of days the student was absent from school with a valid excuse when school was in session between the StartDate and EndDate, inclusive. | xs:decimal | |||||||
UnexcusedAbsences | M | The number of days the student was absent from school without a valid excuse when school was in session between the StartDate and EndDate, inclusive. | xs:decimal | |||||||
DaysTardy | O | The number of days the student was tardy when school was in session between the StartDate and EndDate, inclusive. | xs:decimal | |||||||
DaysInMembership | M | The number of days the student was present plus the number of days the student was absent when school was in session during the period between the StartDate and EndDate, inclusive. | xs:decimal | |||||||
SIF_Metadata | O | SIF_Metadata | ||||||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
StudentContactPersonal | This object contains information about the people who are referenced as student contacts. | |||
@ | RefId | M | The ID (GUID) that uniquely identifies the instance of the object. | RefIdType |
LocalId | O | The locally-assigned identifier for this person. Note: LocalId may be used as a unique person identifier rather than a unique contact identifier. In this case there may be more than one StudentContactPersonal instance with the same LocalId. | LocalId | |
OtherIdList | O | Lists all "other" identifiers associated with the student. | List | |
OtherIdList/OtherId | MR | Lists an "other" identifier associated with the student. | xs:normalizedString | |
@ | Type | M | Code that defines the type of this other ID. | xs:normalizedString |
PersonInfo | M | Personal Information | PersonInfo | |
EmploymentType | O | Code that defines employment type. This is compulsory for Parents or Guardians of the Student. | AUCodeSetsEmploymentTypeType | |
SchoolEducationalLevel | O | The highest level of education completed by the contact person. | EducationalLevel | |
NonSchoolEducation | O | This reflects the level of the Contact’s Non-School Education. | AUCodeSetsNonSchoolEducationType | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
StudentContactRelationship | This object defines a relationship between a contact person and a student. | |||
@ | StudentPersonalRefId | M | GUID that identifies the student for the relationship. | RefIdType |
@ | StudentContactPersonalRefId | M | GUID that identifies the contact person for the relationship. | RefIdType |
Relationship | M | Defines the relationship of the contact to the student. | Relationship | |
HouseholdList | O | List | ||
HouseholdList/Household | MR | Repeatable element containing the ID of a household. | LocalId | |
ContactFlags | C |
Contains Yes/No characteristics of the contact person's role. Provide a | ||
ContactFlags/ParentLegalGuardian | C | Does the individual have parental or legal guardianship responsibility for the student? | AUCodeSetsYesOrNoCategoryType | |
ContactFlags/PickupRights | C | This element tells whether or not the contact has pickup rights. | AUCodeSetsYesOrNoCategoryType | |
ContactFlags/LivesWith | C | Does the student live with this contact? | AUCodeSetsYesOrNoCategoryType | |
ContactFlags/AccessToRecords | C | Does this contact have access to the student's records? | AUCodeSetsYesOrNoCategoryType | |
ContactFlags/EmergencyContact | C | Should this contact be notified in case of emergency? | AUCodeSetsYesOrNoCategoryType | |
ContactFlags/HasCustody | C | Does this contact have or share custody of the student? | AUCodeSetsYesOrNoCategoryType | |
ContactFlags/DisciplinaryContact | C | Is this person to be contacted in case of disciplinary action? | AUCodeSetsYesOrNoCategoryType | |
ContactFlags/PrimaryCareProvider | C | Does this person provide daily living or personal assistance to the student? | AUCodeSetsYesOrNoCategoryType | |
ContactFlags/FeesBilling | C | Is this the contact responsible for Payment of Fees? | AUCodeSetsYesOrNoCategoryType | |
ContactFlags/FamilyMail | C | Does this person receive family mail? | AUCodeSetsYesOrNoCategoryType | |
ContactFlags/InterventionOrder | C | Is there an Intervention Order against this Contact? | AUCodeSetsYesOrNoCategoryType | |
MainlySpeaksEnglishAtHome | O | Is English the main language spoken at home? | AUCodeSetsYesOrNoCategoryType | |
ContactSequence | O | Number indicating the order in which the person should be contacted. | xs:unsignedInt | |
ContactSequenceSource | O | Indicates the source who provided the contact sequence order. | AUCodeSetsSourceCodeTypeType | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object provides daily attendance information for a particular student in a particular school on a particular date.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||||
---|---|---|---|---|---|---|---|---|
StudentDailyAttendance | This object provides daily attendance information for a particular student in a particular school on a particular date. | |||||||
@ | RefId | M | The ID (GUID) assigned to uniquely identify this attendance record. | RefIdType | ||||
StudentPersonalRefId | M | The ID (GUID) of the student for whom this attendance information is being reported. | IdRefType | |||||
SchoolInfoRefId | M | The ID (GUID) of the school for which this attendance information is being reported. | IdRefType | |||||
Date | M | The calendar date to which this attendance information relates. | xs:date | |||||
SchoolYear | M |
School year for which this enrollment is applicable, expressed as the four-digit year in which the school year
ends (e.g. | SchoolYear | |||||
DayValue | O | Value of a day this instance, represents. | AUCodeSetsDayValueCodeType | |||||
AttendanceCode | M | Locally defined code for attendance. | AttendanceCode | |||||
AttendanceStatus | M | Approved or Unapproved status of this attendance code. | AUCodeSetsAttendanceStatusType | |||||
TimeIn | C | The time the student entered or returned to school. Must be provided if ‘Partial’ chosen for DayValue. | xs:time | |||||
TimeOut | C | The time the student left school. Must be provided if ‘Partial’ chosen for DayValue.. | xs:time | |||||
AbsenceValue | C | Must be provided if the DayValue is "Partial" or "Other". The amount of absence represented by AttendanceCode, up to three decimal places. | xs:decimal
| |||||
AttendanceNote | O | Note related to this particular attendance. | xs:normalizedString | |||||
SIF_Metadata | O | SIF_Metadata | ||||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object contains information pertaining to student eligibility for and participation in an individualized special program such as special education, ESL, etc.
Multiple instances of this object may be transmitted for a particular student because the student may participate in multiple programs
and because the details of a student's participation in a given program may change over time. A separate instance of this object must be
generated for each program in which the student participates, and the ProgramType
element is used to identify the particular
program. In addition, each time the student's participation profile changes for a particular program, a new instance of this object must
be generated with the appropriate value in the ProgramType
element, the effective date of the new profile in
StudentParticipationAsOfDate
, and a new RefId
.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||||||
---|---|---|---|---|---|---|---|---|---|---|
StudentParticipation | This object contains information pertaining to student eligibility for and participation in an individualized special program such as special education, ESL, etc.
Multiple instances of this object may be transmitted for a particular student because the student may participate in multiple programs
and because the details of a student's participation in a given program may change over time. A separate instance of this object must be
generated for each program in which the student participates, and the | |||||||||
@ | RefId | M | This is the unique identification code | RefIdType | ||||||
StudentPersonalRefId | M | The GUID of the student that this object is linked to. | IdRefType | |||||||
StudentParticipationAsOfDate | M |
Effective date (NOT the entry date) of this | xs:date | |||||||
ProgramType | O | Identifies the individualised program for which the student's participation is described in this instance | AUCodeSetsStudentFamilyProgramTypeType | |||||||
ProgramFundingSources | O | List of funding sources | List | |||||||
ProgramFundingSources/ProgramFundingSource | MR | Funding source of the special program | ||||||||
ProgramFundingSources/ProgramFundingSource/ Code | M | Funding source for the program, may be more than one. | AUCodeSetsProgramFundingSourceCodeType | |||||||
ProgramFundingSources/ProgramFundingSource/ OtherCodeList | O | OtherCodeList | ||||||||
ManagingSchool | M | The GUID of the school responsible for coordinating the student's program participation. | IdRefType | |||||||
@ | SIF_RefObject | M | values:
| |||||||
StudentSpecialEducationFTE | O | Calculated ratio of time the student is in a special ed setting. Values range from 0.00 to 1.00. If the student is in a special ed setting 25% of the time, the value is .25; if 100% of the time, the value is 1.00. | xs:decimal
| |||||||
ParticipationContact | O | Primary contact for this record. | xs:normalizedString | |||||||
SIF_Metadata | O | SIF_Metadata | ||||||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object allows recording of period level attendance a student. The Australian StudentPeriodAttendance object differs to the US StudentPeriodAttendance object in the following ways:
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
StudentPeriodAttendance | This object allows recording of period level attendance a student. The Australian StudentPeriodAttendance object differs to the US StudentPeriodAttendance object in the following ways:
| |||
@ | RefId | M | The ID (GUID) assigned to uniquely identify this attendance record. | RefIdType |
StudentPersonalRefId | M | The GUID of the student that this attendance applies to. | IdRefType | |
SchoolInfoRefId | M | The school where the attendance was recorded. Somewhat redundant, needed for requests. | IdRefType | |
Date | M | The date of the attendance event. | xs:date | |
SessionInfoRefId | O | The GUID of the session that this attendance applies to. | IdRefType | |
TimetablePeriod | O | The period within which attendance is being reported, e.g. "4D". | xs:normalizedString | |
AttendanceCode | M | Code that describes the absence or attendance | AttendanceCode | |
AttendanceStatus | M | Approved or Unapproved status of this attendance code. | AUCodeSetsAttendanceStatusType | |
SchoolYear | O |
School year for which this enrollment is applicable, expressed as the four-digit year in which the school year
ends (e.g. | SchoolYear | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object contains all the personal information related to the student.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
StudentPersonal | This object contains all the personal information related to the student. | |||
@ | RefId | M | The GUID of the student. | RefIdType |
AlertMessages | O | List | ||
AlertMessages/AlertMessage | MR | This is an alert message that is associated with the student. | xs:string | |
@ | Type | M | This attribute specifies what type of alert message this is. | values:
|
MedicalAlertMessages | O | List | ||
MedicalAlertMessages/MedicalAlertMessage | MR | Medical alert associated with the student. | xs:string | |
@ | Severity | M | The level of severity of this medical alert. | values:
|
LocalId | M | The locally-assigned identifier for this student. | LocalId | |
StateProvinceId | O | The state-assigned identifier for this student. | StateProvinceId | |
ElectronicIdList | O | Electronic identifier(s) associated with this entity. | ElectronicIdList | |
OtherIdList | O | Lists all "other" identifiers associated with the student. | List | |
OtherIdList/OtherId | MR | Lists an "other" identifier associated with the student. | xs:normalizedString | |
@ | Type | M | Code that defines the type of this other ID. | xs:normalizedString |
PersonInfo | M | Personal Information | PersonInfo | |
ProjectedGraduationYear | O | Currently projected graduation year. | ProjectedGraduationYear | |
OnTimeGraduationYear | O | First projected graduation year, usually determined when student is accepted into 9th grade. | OnTimeGraduationYear | |
MostRecent | O | Container for elements reflecting the most recent enrollment of a student. If the student is currently enrolled in the district, the elements contain current information. | ||
MostRecent/SchoolLocalId | O | Local identifier representing the school in which the student is or was most recently enrolled in the district. | LocalId | |
MostRecent/HomeroomLocalId | O |
Local identifier representing the current or most recent homeroom in which the student is or was most recently assigned in the district. Use the value from | LocalId | |
MostRecent/YearLevel | O | The current or most recent grade level of the student in the district. | YearLevel | |
AcceptableUsePolicy | O | Does the student have a current signed Acceptable Use Policy document for system access? | AUCodeSetsYesOrNoCategoryType | |
EconomicDisadvantage | O | Does the student meet the State criteria for classification as having an economic disadvantage? | AUCodeSetsYesOrNoCategoryType | |
ESL | O | Does the student meet ‘English as a Second Language Criteria’? | AUCodeSetsYesOrNoCategoryType | |
YoungCarersRole | O | Is the student a carer of other family members? | AUCodeSetsYesOrNoCategoryType | |
Disability | O | Does the student have funding for disability? | AUCodeSetsYesOrNoCategoryType | |
IntegrationAide | O | Does the Student require an Integration Aide? | AUCodeSetsYesOrNoCategoryType | |
PrePrimaryEducation | O | Care prior to kinder enrolment (eg. Family day care/home/extended care etc). | xs:normalizedString | |
FirstAUSchoolEnrollment | O | Date of the first enrolment in an Australian School | xs:date | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object defines information related to a student's enrollment. StudentSchoolEnrollment instances must not span multiple school years.
Note there is only one current home enrollment at a time per student.
Only one instance of the StudentSchoolEnrollment
object must exist for a given student with MembershipType
=01
(Home School) and TimeFrame
=C
(Current)
for the time interval between EntryDate
and ExitDate
, inclusive.
Agents are required to re-publish a StudentSchoolEnrollment
object Change
event when the
TimeFrame
attribute changes, regardless of when the data entry is done.
This is in addition to the practice of publishing the object Change
event at the time the data changes in the corresponding application.
When the object is re-published, it must contain all the data in the object that is supported by the publisher.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||||||
---|---|---|---|---|---|---|---|---|---|---|
StudentSchoolEnrollment | This object defines information related to a student's enrollment. StudentSchoolEnrollment instances must not span multiple school years.
Note there is only one current home enrollment at a time per student.
Only one instance of the
Agents are required to re-publish a When the object is re-published, it must contain all the data in the object that is supported by the publisher. | |||||||||
@ | RefId | M | The ID (GUID) that uniquely identifies a particular enrollment. | RefIdType | ||||||
StudentPersonalRefId | M | The ID (GUID) of the student to whom this information is linked. | IdRefType | |||||||
SchoolInfoRefId | M | The ID (GUID) of the school to which this enrollment applies. | IdRefType | |||||||
MembershipType | M | The type of this enrollment as it relates to the school identified in SchoolInfoRefId. | AUCodeSetsSchoolEnrollmentTypeType | |||||||
TimeFrame | M |
The timeframe of the enrollment based on the | AUCodeSetsEnrollmentTimeFrameType | |||||||
SchoolYear | M |
School year for which this enrollment is applicable, expressed as the four-digit year in which the school year ends (e.g. | SchoolYear | |||||||
EntryDate | M | The date from when this enrollment is valid. | xs:date | |||||||
EntryType | O | Container elements for EntryType information | ||||||||
EntryType/Code | M | Code indicating the type of entry for this enrollment | AUCodeSetsEntryTypeType | |||||||
EntryType/OtherCodeList | O | List of other codes or strings that crosswalk to or serve as translations of the Code element paired with this common element. If Code changes and OtherCodes are supported, both Code and all associated OtherCode elements must be present. | OtherCodeList | |||||||
YearLevel | O | Year or academic level of student. | YearLevel | |||||||
Homeroom | O | Homeroom for this enrollment. | IdRefType | |||||||
@ | SIF_RefObject | M | The name of the object referenced. | values:
| ||||||
Advisor | O | Staff member assigned as an advisor. | IdRefType | |||||||
@ | SIF_RefObject | M | The name of the object referenced. | values:
| ||||||
Counselor | O | Staff member assigned as an advisor. | IdRefType | |||||||
@ | SIF_RefObject | M | The name of the object referenced. | values:
| ||||||
Homegroup | O | The name of the homegroup the student enrollment belongs to. | xs:normalizedString | |||||||
House | O | The name of the house the student belongs to. | xs:normalizedString | |||||||
IndividualLearningPlan | O | Does this student have an individual learning plan in place? | AUCodeSetsYesOrNoCategoryType | |||||||
Calendar | O | The calendar assigned to this enrollment. | IdRefType | |||||||
@ | SIF_RefObject | M | The name of the object referenced. | values:
| ||||||
ExitDate | C |
The last school calendar day of this enrollment. If the student has exited the school or the enrollment has a | xs:date | |||||||
ExitStatus | O | Container element for exit status codes. | ||||||||
ExitStatus/Code | M | Code indicating the closure status for this enrollment. | AUCodeSetsExitWithdrawalStatusType | |||||||
ExitStatus/OtherCodeList | O | OtherCodeList | ||||||||
ExitType | O | |||||||||
ExitType/Code | M | Code indicating the type of exit for this enrollment. | AUCodeSetsExitWithdrawalTypeType | |||||||
ExitType/OtherCodeList | O | OtherCodeList | ||||||||
FTE | O | Full-time equivalent numeric value of the student's course load during this enrollment, expressed in decimal form, where 1.00 represents a full-time enrollment. | xs:decimal
| |||||||
FTPTStatus | O | An indication of whether the student is enrolled full time or part time. | AUCodeSetsFTPTStatusCodeType | |||||||
CatchmentStatus | O | Container element for location of an individual's legal residence relative to (within or outside) the boundaries of the school for this enrolment. Enrolment Catchment Status. | ||||||||
CatchmentStatus/Code | M | Code indicating the residency status for this enrollment. Code indicating Enrollment Catchment Status. | AUCodeSetsPublicSchoolCatchmentStatusType | |||||||
CatchmentStatus/OtherCodeList | O | List of other codes or strings that crosswalk to or serve as translations of the Code element paired with this common element. If Code changes and OtherCodes are supported, both Code and all associated OtherCode elements must be present. | OtherCodeList | |||||||
RecordClosureReason | O | The reason why this enrollment was closed. The EndOfYear option must be used to convey status change due to rollover activity. | values:
| |||||||
PromotionInfo | O | Information on a student’s promotion, retention, or demotion related to this enrollment instance. | ||||||||
PromotionInfo/PromotionStatus | O | This value should be set if this enrollment instance is closed for an end-of-year closeout or a mid-year promotion or demotion. A value other than NA should be specified when the enrollment instance represents an end-of-year closeout or mid-year promotion/demotion. | values:
| |||||||
PreviousSchool | O | If the student has previously been enrolled at a school, i.e. student is transferring, the previous school number. | LocalId | |||||||
DestinationSchool | O | If the student has exited the school, the local id of the school to which the student has transferred to. | LocalId | |||||||
StudentSubjectChoiceList | O | List of Student Subject Choices where available. | List | |||||||
StudentSubjectChoiceList/ StudentSubjectChoice | MR | Subjects Students Choose | ||||||||
StudentSubjectChoiceList/ StudentSubjectChoice/PreferenceNumber | O | Subject Priority | xs:unsignedInt | |||||||
StudentSubjectChoiceList/ StudentSubjectChoice/SubjectLocalId | M | Local Subject Id | LocalId | |||||||
StudentSubjectChoiceList/ StudentSubjectChoice/StudyDescription | O | Description about Study Mode. | SubjectArea | |||||||
StudentSubjectChoiceList/ StudentSubjectChoice/OtherSchoolLocalId | O | Localid of a school where the student studies this subject if not at the home school. | LocalId | |||||||
SIF_Metadata | O | SIF_Metadata | ||||||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object has been developed to cater for the SDTN – Student Data Transfer Note. http://www.mceecdya.edu.au/verve/_resources/ISDTN_Form_3_Transfer_Note_Oct_06.pdf The elements in this object have been developed to support the LIMF recommendations and allow two or more jurisdictions to exchange this data. http://www.aictec.edu.au/aictec/go/home/about/pid/289
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
StudentSDTN | This object has been developed to cater for the SDTN – Student Data Transfer Note. http://www.mceecdya.edu.au/verve/_resources/ISDTN_Form_3_Transfer_Note_Oct_06.pdf The elements in this object have been developed to support the LIMF recommendations and allow two or more jurisdictions to exchange this data. http://www.aictec.edu.au/aictec/go/home/about/pid/289 | |||
@ | RefId | M | The GUID that uniquely identifies this SDTN Object. | RefIdType |
SnapDate | M | The date that this object was sent. | xs:date | |
StudentPersonalRefId | M | The RefId of the StudentPersonal object at the sending school. | IdRefType | |
PersonInfo | M | Personal Information. | PersonInfo | |
SchoolInfoRefId | M | GUID that identifies the school that provided the SDTN. | IdRefType | |
SchoolLocalId | O | The locally-assigned identifier for the school in the original database (sender) | LocalId | |
SchoolName | M | Name of school/campus. | xs:normalizedString | |
AddressList | O | The school's addresses. | AddressList | |
PrincipalInfo | O | Information about the campus or school principal. | PrincipalInfo | |
FurtherInformation | O | |||
FurtherInformation/ContactName | O | The name of the person to contact for further information on this student. | NameOfRecordType | |
FurtherInformation/PhoneNumberList | O | The further contact person’s phone number(s). | PhoneNumberList | |
FurtherInformation/EmailList | O | The further contact person’s e-mail address(es). | EmailList | |
EnrollmentDate | O | The date when the student first attended the school. | xs:date | |
DepartureDate | O | The last school calendar day the student attended or sign-out date if departure is before end of school year. | xs:date | |
YearLevel | O | School Year or academic level of student at departure date. | YearLevel | |
ReasonForLeaving | O | xs:normalizedString | ||
PreviousSchoolsList | O | List of Previous Schools if known (other than the provider school) | List | |
PreviousSchoolsList/PreviousSchool | MR | Repeatable element of previous schools information if known. (other than the provider school) | ||
PreviousSchoolsList/PreviousSchool/ SchoolName | M | Previous School Name | xs:normalizedString | |
PreviousSchoolsList/PreviousSchool/ ReasonLeft | O | Reason for leaving previous school if known. | xs:normalizedString | |
AttendanceConcerns | O | Indicator of whether the Student had attendance concerns worth noting. | AUCodeSetsYesOrNoCategoryType | |
HealthNeeds | O | Indicator of whether the Student has any Health Care Needs. | AUCodeSetsYesOrNoCategoryType | |
AreasOfInterestList | O | List | ||
AreasOfInterestList/ActivityInfo | MR | Repeatable element containing activities student has an interest in or participates in. | ||
AreasOfInterestList/ActivityInfo/ StudentActivityInfoRefId | O | GUID that identifies the activity in which the student participates. | IdRefType | |
AreasOfInterestList/ActivityInfo/ StudentActivityDescription | M | Description of Activity Info in the Previous Schools’ zone. | xs:normalizedString | |
NegotiatedCurriculumPlan | O | Does the student have a negotiated curriculum plan? | AUCodeSetsYesOrNoCategoryType | |
AdjustedEducationProgram | O | Does the student have an adjusted education program? | AUCodeSetsYesOrNoCategoryType | |
CareerGuidanceFileHeld | O | Does the student have a career guidance file? | AUCodeSetsYesOrNoCategoryType | |
SchoolCounsellorFileHeld | O | Is there a School counsellor/psychologist file held? | AUCodeSetsYesOrNoCategoryType | |
OtherLearningSupport | O | Comments describing any other required learning support, eg ESL needs. | xs:string | |
AcceleratedProgram | O | Did the student participate in an accelerated learning program? | AUCodeSetsYesOrNoCategoryType | |
YoungCarersRole | O | Is the student a carer of other family members? | AUCodeSetsYesOrNoCategoryType | |
Literacy | O | Progress in Literacy or English according to the National Standard. | AUCodeSetsProgressLevelType | |
Numeracy | O | Progress in Numeracy or Maths according to the National Standard. | AUCodeSetsProgressLevelType | |
OtherLearningAreasList | O | List | ||
OtherLearningAreasList/OtherLearningArea | MR | Repeatable element of progress in other learning areas. | ||
OtherLearningAreasList/OtherLearningArea/ Description | M | Description of Other Learning Area. | xs:normalizedString | |
OtherLearningAreasList/OtherLearningArea/ Result | O | Progress in other learning area according to the National Standard. | AUCodeSetsProgressLevelType | |
LatestStudentReportAvailable | O | Is the latest student report available? | AUCodeSetsYesOrNoCategoryType | |
PastoralCare | O | Pastoral care and behaviour management | ||
PastoralCare/DisciplinaryAbsences | O | Have there been any school disciplinary absences (in or out of school) in the last 12 months | AUCodeSetsYesOrNoCategoryType | |
PastoralCare/IndividualBehaviourPlan | O | Is there an individual behaviour management plan | AUCodeSetsYesOrNoCategoryType | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object provides a snapshot of a student's record on a given day. All information reported in the object is reported as it appeared in the responding system on the date specified in SnapDate. It can be used for synching data across applications, for periodically loading a data warehouse, or for vertical reporting of data to a requesting authority, such as a state department of education.
SIF_Events are not reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
StudentSnapshot | This object provides a snapshot of a student's record on a given day. All information reported in the object is reported as it appeared in the responding system on the date specified in SnapDate. It can be used for synching data across applications, for periodically loading a data warehouse, or for vertical reporting of data to a requesting authority, such as a state department of education. | |||
@ | SnapDate | M | The date the data snapshot was taken. Some elements are provided/calculated as of the SnapDate, and some are provided as of the date the object is requested (i.e., some can be historical and some will represent the last information available/last known value). In a SIS the following elements are provided/calculated as of the SnapDate: Age, HomeEnrollment and all its child elements. Other applications (e.g., data warehouses) may be able to provide values for other elements on various snap dates. | xs:date |
@ | StudentPersonalRefId | M | The ID (GUID) of the student to whom this information relates. | IdRefType |
SchoolYear | M |
School year in which the SnapDate falls, and for which the information is applicable, expressed as the four-digit year
in which the school year ends (e.g. | SchoolYear | |
Name | M | The name of the student. | Name | |
LocalId | M | The locally-defined identifier for this student. | LocalId | |
StateProvinceId | O | The state-assigned identifier for this student. | StateProvinceId | |
Sex | O | 'Sex' is the distinction 'male' and 'female', as reported by the person. | AUCodeSetsSexCodeType | |
BirthDate | O | The person's date of birth. | BirthDate | |
Age | O | The age (in years) of the student on the date in SnapDate. | xs:unsignedInt | |
ProjectedGraduationYear | O | Currently projected graduation year. | ProjectedGraduationYear | |
OnTimeGraduationYear | O | First projected graduation year, usually determined when student is accepted into ninth grade. | OnTimeGraduationYear | |
StudentSubjectChoiceList | O | List of Student Subject Choices where available. | List | |
StudentSubjectChoiceList/ StudentSubjectChoice | MR | Subjects Students Choose | ||
StudentSubjectChoiceList/ StudentSubjectChoice/PreferenceNumber | O | Subject Priority | xs:unsignedInt | |
StudentSubjectChoiceList/ StudentSubjectChoice/SubjectLocalId | M | Local Subject Id | LocalId | |
StudentSubjectChoiceList/ StudentSubjectChoice/StudyDescription | O | Description about Study Mode. | SubjectArea | |
StudentSubjectChoiceList/ StudentSubjectChoice/OtherSchoolLocalId | O | Localid of a school where the student studies this subject if not at the home school. | LocalId | |
HomeEnrollment | M | Enrollment-related information for the school that is responsible for reporting the student's membership/child accounting information. This is most likely the primary enrollment site for the student. | ||
HomeEnrollment/StudentSchoolEnrollmentRefId | O | The ID (GUID) of the StudentSchoolEnrollment object from which the enrollment information is derived. | IdRefType | |
HomeEnrollment/SchoolName | O | Name of the school. | xs:normalizedString | |
HomeEnrollment/SchoolInfoRefId | C | The ID (GUID) of the school. Provide both the HomeEnrollment/SchoolInfoRefId and HomeEnrollment/LocalId elements if possible. If not, one or the other must be provided. | IdRefType | |
HomeEnrollment/LocalId | C | The locally-defined identifier for this school. Provide both the HomeEnrollment/LocalId and HomeEnrollment/SchoolId elements if possible. If not, one or the other must be provided. | LocalId | |
HomeEnrollment/SchoolNo | O | The state or province defined identifier for this school. | LocalId | |
HomeEnrollment/YearLevel | O | Year or academic level of student. | YearLevel | |
HomeEnrollment/Homeroom | O | HomeGroup this student belongs to | IdRefType | |
@ | SIF_RefObject | M | The name of the SIF object referenced. | values:
|
HomeEnrollment/HomeroomNumber | O | The locally-defined identifier of that room | HomeroomNumber | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
A key Australian business requirement is the ability to publish a complete student status update on demand. This status may include multiple school enrolments.
This object supports the publishing of a consolidated student update containing all school enrollments and the student’s classes at each school.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SummaryEnrollmentInfo | A key Australian business requirement is the ability to publish a complete student status update on demand. This status may include multiple school enrolments. This object supports the publishing of a consolidated student update containing all school enrollments and the student’s classes at each school. | |||
@ | RefId | M | The ID (GUID) that uniquely identifies the enrollment. | RefIdType |
SchoolYear | M | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2009"). | SchoolYear | |
ParentObjectRefId | M | The GUID of the related parent object | RefIdType | |
@ | SIF_RefObject | M | values:
| |
LocalId | M | The locally-defined identifier for this student/teacher. | LocalId | |
StateProvinceId | O | The state-assigned identifier for this student/teacher. | StateProvinceId | |
PersonInfo | M | Personal Information. | PersonInfo | |
SchoolEnrollmentList | M | List of school enrollments for a Student or assignments for a Staff member. There must be at least one. | List | |
SchoolEnrollmentList/SchoolEnrollment | MR | School information for the Student enrollment or Staff assignment. There must be at least one. | ||
SchoolEnrollmentList/SchoolEnrollment/ SchoolName | M | Name of school/campus. | xs:normalizedString | |
SchoolEnrollmentList/SchoolEnrollment/ SchoolInfoRefId | C | The ID (GUID) of the school. Provide both the SchoolInfo RefId and LocalId elements if possible. If not, one or the other must be provided. | RefIdType | |
SchoolEnrollmentList/SchoolEnrollment/ SchoolLocalId | C | The locally-defined identifier for this school. Provide both the LocalId and SchoolId elements if possible. If not, one or the other must be provided. | LocalId | |
SchoolEnrollmentList/SchoolEnrollment/ SchoolStateProvinceId | O | The state or province defined identifier for this school. | StateProvinceId | |
SchoolEnrollmentList/SchoolEnrollment/ Student | C | Either the Staff or Student must be provided. | ||
SchoolEnrollmentList/SchoolEnrollment/ Student/StudentSchoolEnrollmentRefId | M | The ID (GUID) of the StudentSchoolEnrollment object from which the enrollment information is derived. | RefIdType | |
SchoolEnrollmentList/SchoolEnrollment/ Student/StudentLocalId | O | The locally-defined identifier for this Student. | LocalId | |
SchoolEnrollmentList/SchoolEnrollment/ Staff | C | Either the Staff or Student must be provided. | ||
SchoolEnrollmentList/SchoolEnrollment/ Staff/StaffAssignmentRefId | M | The ID (GUID) of the StaffAssignment object from which the enrollment information is derived. | RefIdType | |
SchoolEnrollmentList/SchoolEnrollment/ Staff/StaffLocalId | O | The locally-defined identifier for this Staff. | LocalId | |
SchoolEnrollmentList/SchoolEnrollment/ EnrollmentList | O | A List of enrolments. Note these are enrolments at a class level rather than at a school level. | List | |
SchoolEnrollmentList/SchoolEnrollment/ EnrollmentList/Enrollment | MR | Enrollment at the class level. | ||
SchoolEnrollmentList/SchoolEnrollment/ EnrollmentList/Enrollment/ TeachingGroupRefId | O | GUID that identifies this Class as a Teaching Group. | IdRefType | |
SchoolEnrollmentList/SchoolEnrollment/ EnrollmentList/Enrollment/ SchoolCourseInfoRefId | O | GUID that identifies this Course for this class. | IdRefType | |
SchoolEnrollmentList/SchoolEnrollment/ EnrollmentList/Enrollment/ TimeTableSubjectRefId | O | GUID that identifies this Subject/Offering for this class. | IdRefType | |
SchoolEnrollmentList/SchoolEnrollment/ EnrollmentList/Enrollment/ LocalId | M | Local Class ID for this enrolment. Should be the same as the LocalId in the TeachingGroup | LocalId | |
SchoolEnrollmentList/SchoolEnrollment/ EnrollmentList/Enrollment/ ShortName | O | Short free format label that describes the class. Should be the same as the ShortName in the TeachingGroup | xs:normalizedString | |
SchoolEnrollmentList/SchoolEnrollment/ EnrollmentList/Enrollment/ SchoolYear | O | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2009"). | SchoolYear | |
SchoolEnrollmentList/SchoolEnrollment/ EnrollmentList/Enrollment/ SubjectLocalId | O | The local subject/offering code for this class. | LocalId | |
SchoolEnrollmentList/SchoolEnrollment/ EnrollmentList/Enrollment/ CourseLocalId | O | The local course code for this class. | LocalId | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object identifies a particular Teaching Group or class in a particular a time table.
The proposed object is based on the UK B1: TeachingGroup object. For the Australian object, a subject being taught at any one year level can have more than one �teaching group� in any one time table. Also a teaching group can be brought together for more than one subject.
All local ids in non-authoritative objects are optional. It is therefore up to the provider and the actual agent's design and choreography to determine whether or not to use or local ids from parent objects. There are cases in some subscribing systems where it might not possible to add RefId columns and therefore the RefId of related objects cannot be stored. For example a target system that listens to TimeTableSubject events and updates them may not be able to store the associated SchoolCourseInfoRefId with that object. The only way it can link the TimeTableSubject object with the appropriate course might be through its local course id. Having local ids that link the parent objects with the child object can simplify the agent design. Generally it is suggested to use the appropriate RefIds whenever possible and only use local ids if there is no other way to use RefIds.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
TeachingGroup | This object identifies a particular Teaching Group or class in a particular a time table. The proposed object is based on the UK B1: TeachingGroup object. For the Australian object, a subject being taught at any one year level can have more than one �teaching group� in any one time table. Also a teaching group can be brought together for more than one subject. All local ids in non-authoritative objects are optional. It is therefore up to the provider and the actual agent's design and choreography to determine whether or not to use or local ids from parent objects. There are cases in some subscribing systems where it might not possible to add RefId columns and therefore the RefId of related objects cannot be stored. For example a target system that listens to TimeTableSubject events and updates them may not be able to store the associated SchoolCourseInfoRefId with that object. The only way it can link the TimeTableSubject object with the appropriate course might be through its local course id. Having local ids that link the parent objects with the child object can simplify the agent design. Generally it is suggested to use the appropriate RefIds whenever possible and only use local ids if there is no other way to use RefIds. | |||
@ | RefId | M | The GUID of the TeachingGroup | RefIdType |
SchoolYear | M | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007"). | SchoolYear | |
LocalId | M | LocalId of the Teaching Group (previously ClassIndicator). | LocalId | |
ShortName | M | Short free format label that describes the group. | xs:normalizedString | |
LongName | O | Longer description of required | xs:normalizedString | |
Set | O | Set Number (UK) | xs:normalizedString | |
Block | O | Block (UK) | xs:normalizedString | |
CurriculumLevel | O | Assessment Stage eg VELS Level | xs:normalizedString | |
SchoolInfoRefId | O | GUID of SchoolInfo object this teaching group belongs to. | RefIdType | |
SchoolLocalId | O | Local School Id. | LocalId | |
SchoolCourseInfoRefId | O | GUID of SchoolCourseInfo object this teaching group is part of. | RefIdType | |
SchoolCourseLocalId | O | Local Course Id. | LocalId | |
TimeTableSubjectRefId | O | GUID of TimeTableSubject object this teaching group belongs to. | RefIdType | |
TimeTableSubjectLocalId | O | Local subject Id. | LocalId | |
StudentList | O | List of Students in this Teaching Group | List | |
StudentList/TeachingGroupStudent | MR | Students who belong to the TeachingGroup | ||
StudentList/TeachingGroupStudent/ StudentPersonalRefId | O | GUID from the StudentPersonal or StudentSnapshot Object (if known), that identifies the student. | IdRefType | |
StudentList/TeachingGroupStudent/ StudentLocalId | M | Local Id of the Student | LocalId | |
StudentList/TeachingGroupStudent/ Name | M | Name of student | NameOfRecordType | |
TeacherList | O | A List of teachers associated with the group – may or maynot include the teacher timetabled in the schedule. | List | |
TeacherList/TeachingGroupTeacher | MR | Teacher associated with the Teaching group – may or may not be the teacher timetabled in the schedule | ||
TeacherList/TeachingGroupTeacher/ StaffPersonalRefId | O | GUID from the StaffPersonal Object that identifies the Staff member | IdRefType | |
TeacherList/TeachingGroupTeacher/ StaffLocalId | M | LocalId of the Staff member | LocalId | |
TeacherList/TeachingGroupTeacher/ Name | M | NameOfRecordType | ||
TeacherList/TeachingGroupTeacher/ Association | M | Association with the Teaching Group (free format for this release) | xs:normalizedString | |
MinClassSize | O | Minimum class size. | xs:integer | |
MaxClassSize | O | Maximum class size | xs:integer | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object provides information about a term; i.e., a reportable period of time.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||||||
---|---|---|---|---|---|---|---|---|---|---|
TermInfo | This object provides information about a term; i.e., a reportable period of time. | |||||||||
@ | RefId | M | The ID (GUID) that uniquely identifies this TermInfo entity. | RefIdType | ||||||
SchoolInfoRefId | M | The ID (GUID) that identifies the school where the term is used. | IdRefType | |||||||
SchoolYear | M | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2009"). | SchoolYear | |||||||
StartDate | M | Starting date of the term. | xs:date | |||||||
EndDate | M | Ending date of the term. | xs:date | |||||||
Description | O | Text-based description of the term. | xs:normalizedString | |||||||
RelativeDuration | O | Portion of the school year represented by this term, expressed in decimal form precise to 4 decimal places (e.g., 0.1333). | xs:decimal
| |||||||
TermCode | O | Locally-defined code. | xs:normalizedString | |||||||
Track | O | The name, description, or code of the track that contains this term. This is used when there are multiple tracks within a school. For instance, kindergarten commonly has a different set of terms than other grades within the school. | xs:normalizedString | |||||||
TermSpan | O | What sort of Session this TermSpan equates to. | AUCodeSetsSessionTypeType | |||||||
MarkingTerm | O | Does this TermInfo represent a marking period? | AUCodeSetsYesOrNoCategoryType | |||||||
SchedulingTerm | O | Does this TermInfo represent a scheduling term? | AUCodeSetsYesOrNoCategoryType | |||||||
AttendanceTerm | O | Does this TermInfo represent an attendance term? | AUCodeSetsYesOrNoCategoryType | |||||||
SIF_Metadata | O | SIF_Metadata | ||||||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
The purpose of this object is to define a schedule or Time Table structure/skeleton for the school. The Time Table is produced by the Time Tabling software. Once the Time Table is produced, the time tabling software creates the schedule based on business rules and constraints to fit into the time table structure.
The proposed Time Table object is based on a combination of the proposed UK B6 – Timetable Cycle Object and Timetable Scope Object.
The Time Table is identified uniquely in the SIF Zone by its' GUID, School and School Year. A Time Table is linked to a particular school.
All local ids in non-authoritative objects are optional. It is therefore up to the provider and the actual agent's design and choreography to determine whether or not to use or local ids from parent objects. There are cases in some subscribing systems where it might not possible to add RefId columns and therefore the RefId of related objects cannot be stored. For example a target system that listens to TimeTableSubject events and updates them may not be able to store the associated SchoolCourseInfoRefId with that object. The only way it can link the TimeTableSubject object with the appropriate course might be through its local course id. Having local ids that link the parent objects with the child object can simplify the agent design. Generally it is suggested to use the appropriate RefIds whenever possible and only use local ids if there is no other way to use RefIds.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
TimeTable | The purpose of this object is to define a schedule or Time Table structure/skeleton for the school. The Time Table is produced by the Time Tabling software. Once the Time Table is produced, the time tabling software creates the schedule based on business rules and constraints to fit into the time table structure. The proposed Time Table object is based on a combination of the proposed UK B6 – Timetable Cycle Object and Timetable Scope Object. The Time Table is identified uniquely in the SIF Zone by its' GUID, School and School Year. A Time Table is linked to a particular school. All local ids in non-authoritative objects are optional. It is therefore up to the provider and the actual agent's design and choreography to determine whether or not to use or local ids from parent objects. There are cases in some subscribing systems where it might not possible to add RefId columns and therefore the RefId of related objects cannot be stored. For example a target system that listens to TimeTableSubject events and updates them may not be able to store the associated SchoolCourseInfoRefId with that object. The only way it can link the TimeTableSubject object with the appropriate course might be through its local course id. Having local ids that link the parent objects with the child object can simplify the agent design. Generally it is suggested to use the appropriate RefIds whenever possible and only use local ids if there is no other way to use RefIds. | |||
@ | RefId | M | GUID that identifies this TimeTable object. | RefIdType |
SchoolInfoRefId | O | Optional the GUID of the SchoolInfo Object if this object is known in the zone. | IdRefType | |
SchoolYear | M | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007"). | SchoolYear | |
LocalId | O | Local TimeTable ID | LocalId | |
Title | M | Unique Name of the proposed Time Table | xs:normalizedString | |
DaysPerCycle | M | Max Number of days per Time Table cycle | xs:unsignedInt | |
PeriodsPerDay | M | Max Number of periods per Time Table Day | xs:unsignedInt | |
TeachingPeriodsPerDay | O | Teaching periods per day if different to PeriodsPerDay | xs:unsignedInt | |
SchoolLocalId | O | Optional Local School Id | LocalId | |
SchoolName | O | The school name in plain text. | xs:normalizedString | |
TimeTableCreationDate | O | Date Schedule was created or last edited. | xs:date | |
StartDate | O | First day of TimeTable. | xs:date | |
EndDate | O | Last day of the TimeTable. | xs:date | |
TimeTableDayList | M | Container for TimeTableDays in Schedule | List | |
TimeTableDayList/TimeTableDay | MR | This element identifies a ‘day’ in a TimeTable. | ||
TimeTableDayList/TimeTableDay/ DayId | M | Local Time Table Identifier | LocalId | |
TimeTableDayList/TimeTableDay/ DayTitle | M | xs:normalizedString | ||
TimeTableDayList/TimeTableDay/ TimeTablePeriodList | M | Title of Day eg. Monday or Day 1 | List | |
TimeTableDayList/TimeTableDay/ TimeTablePeriodList/TimeTablePeriod | MR | Container for TimeTablePeriods in a Time Table Day | ||
TimeTableDayList/TimeTableDay/ TimeTablePeriodList/TimeTablePeriod/ PeriodId | M | Period in Day Identifier | LocalId | |
TimeTableDayList/TimeTableDay/ TimeTablePeriodList/TimeTablePeriod/ PeriodTitle | M | Title of Period eg. Session 1 or Period 1 | xs:normalizedString | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
The purpose of this object is to identify a specific cell within a particular TimeTable. A time table is a structure that represents all the available days and times (periods) for which a particular teaching group, or subject can be scheduled.
A TimeTableCell is uniquely identified in the ZIF zone by its' GUID.
And the following must be provided at object creation:
All local ids in non-authoritative objects are optional. It is therefore up to the provider and the actual agent's design and choreography to determine whether or not to use or local ids from parent objects. There are cases in some subscribing systems where it might not possible to add RefId columns and therefore the RefId of related objects cannot be stored. For example a target system that listens to TimeTableSubject events and updates them may not be able to store the associated SchoolCourseInfoRefId with that object. The only way it can link the TimeTableSubject object with the appropriate course might be through its local course id. Having local ids that link the parent objects with the child object can simplify the agent design. Generally it is suggested to use the appropriate RefIds whenever possible and only use local ids if there is no other way to use RefIds.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
TimeTableCell | The purpose of this object is to identify a specific cell within a particular TimeTable. A time table is a structure that represents all the available days and times (periods) for which a particular teaching group, or subject can be scheduled. A TimeTableCell is uniquely identified in the ZIF zone by its' GUID. And the following must be provided at object creation:
All local ids in non-authoritative objects are optional. It is therefore up to the provider and the actual agent's design and choreography to determine whether or not to use or local ids from parent objects. There are cases in some subscribing systems where it might not possible to add RefId columns and therefore the RefId of related objects cannot be stored. For example a target system that listens to TimeTableSubject events and updates them may not be able to store the associated SchoolCourseInfoRefId with that object. The only way it can link the TimeTableSubject object with the appropriate course might be through its local course id. Having local ids that link the parent objects with the child object can simplify the agent design. Generally it is suggested to use the appropriate RefIds whenever possible and only use local ids if there is no other way to use RefIds. | |||
@ | RefId | M | The GUID of the TimeTableCell | RefIdType |
TimeTableRefId | M | The GUID of the TimeTable to which this Cell belongs | IdRefType | |
TimeTableSubjectRefId | M | The GUID of the Subject that this Cell is scheduling | IdRefType | |
TeachingGroupRefId | M | The GUID of the TeachingGroup being scheduled | IdRefType | |
RoomInfoRefId | M | The GUID of the Resource being Scheduled | IdRefType | |
StaffPersonalRefId | M | The GUID of the Staff Member being Scheduled | IdRefType | |
TimeTableLocalId | O | Time Table Local Identifier | LocalId | |
SubjectLocalId | O | Subject Local Id | LocalId | |
TeachingGroupLocalId | O | Teaching Group | LocalId | |
RoomNumber | M | Room number as presented to the user/application. | HomeroomNumber | |
StaffLocalId | O | Staff LocalId | LocalId | |
DayId | M | Day Id | LocalId | |
PeriodId | M | Period Id within the Day Id | LocalId | |
CellType | M | Type of Lesson/Session eg Teaching, Lunch etc | xs:normalizedString | |
SchoolInfoRefId | O | Optional the GUID of the SchoolInfo Object if this object is known in the zone | IdRefType | |
SchoolLocalId | O | Optional Local School Id | LocalId | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This purpose of this object is to define and communicate the subject or distinct piece of curriculum that needs to be scheduled by the time table generator. This is a new object proposed to meet SIF-AU needs. Reviews of the existing specifications identified two relevant objects – SchoolCourseInfo, defined in SIF US 2.2 specification and SchoolGroup, defined within the SIF UK 1.1 specification. These objects appear to have some similar context but seem overly complex considering that Australian requirements, which are limited to the Student Administration System or Curriculum Delivery System providing base information to the Time Tabling application about what curriculum offerings are being proposed. When this data is sent in a Request/Response only those subjects that are relevant to be scheduled (or active), should be sent to the TimeTabling application.
All local ids in non-authoritative objects are optional. It is therefore up to the provider and the actual agent's design and choreography to determine whether or not to use or local ids from parent objects. There are cases in some subscribing systems where it might not possible to add RefId columns and therefore the RefId of related objects cannot be stored. For example a target system that listens to TimeTableSubject events and updates them may not be able to store the associated SchoolCourseInfoRefId with that object. The only way it can link the TimeTableSubject object with the appropriate course might be through its local course id. Having local ids that link the parent objects with the child object can simplify the agent design. Generally it is suggested to use the appropriate RefIds whenever possible and only use local ids if there is no other way to use RefIds.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
TimeTableSubject | This purpose of this object is to define and communicate the subject or distinct piece of curriculum that needs to be scheduled by the time table generator. This is a new object proposed to meet SIF-AU needs. Reviews of the existing specifications identified two relevant objects – SchoolCourseInfo, defined in SIF US 2.2 specification and SchoolGroup, defined within the SIF UK 1.1 specification. These objects appear to have some similar context but seem overly complex considering that Australian requirements, which are limited to the Student Administration System or Curriculum Delivery System providing base information to the Time Tabling application about what curriculum offerings are being proposed. When this data is sent in a Request/Response only those subjects that are relevant to be scheduled (or active), should be sent to the TimeTabling application. All local ids in non-authoritative objects are optional. It is therefore up to the provider and the actual agent's design and choreography to determine whether or not to use or local ids from parent objects. There are cases in some subscribing systems where it might not possible to add RefId columns and therefore the RefId of related objects cannot be stored. For example a target system that listens to TimeTableSubject events and updates them may not be able to store the associated SchoolCourseInfoRefId with that object. The only way it can link the TimeTableSubject object with the appropriate course might be through its local course id. Having local ids that link the parent objects with the child object can simplify the agent design. Generally it is suggested to use the appropriate RefIds whenever possible and only use local ids if there is no other way to use RefIds. | |||
@ | RefId | M | GUID that identifies this TimeTableSubject. | RefIdType |
SubjectLocalId | M | SubjectLocalID - Distinct piece of curriculum that is to be scheduled. | LocalId | |
AcademicYear | C | Subject Year Level. Either AcademicYear or AcademicYearRange must be provided. | YearLevel | |
AcademicYearRange | C | Range of Academic Years subject spans. Either AcademicYear or AcademicYearRange must be provided. | ||
AcademicYearRange/Start | M | Lowest year in range. | YearLevel | |
AcademicYearRange/End | M | Highest year in range | YearLevel | |
CourseLocalId | O | Local Course Id, if associated with a Course. | LocalId | |
SchoolCourseInfoRefId | O | The GUID of the SchoolCourseInfo object. | RefIdType | |
Faculty | O | Faculty | xs:normalizedString | |
SubjectShortName | O | SubjectShortName | xs:normalizedString | |
SubjectLongName | M | SubjectLongName | xs:normalizedString | |
SubjectType | O | Core or Elective or ? | xs:normalizedString | |
ProposedMaxClassSize | O | Suggested maximum class size for this subject. | xs:decimal | |
ProposedMinClassSize | O | Suggested minimum class size for this subject. | xs:decimal | |
SchoolInfoRefId | O | Optional the GUID of the SchoolInfo Object if this object is known in the zone. | IdRefType | |
SchoolLocalId | O | Optional Local School Id | LocalId | |
Semester | O | Semester, Term, or Quarter subject offered. | xs:unsignedInt | |
SchoolYear | O | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007"). | SchoolYear | |
OtherCodeList | O | Any other codes this subject is known by; eg VASS code for VCE in Vic. | OtherCodeList | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |