These diagrams represent the objects used in scheduling and timetabling. The objects allow schools to securely provide SIS information to the Timetabling and/or Scheduling product of their choice, and also to allow timetable records (including teaching groups and scheduled activities), to be published to a jurisdictional data hub.
This object represents any resource object that is not already described in SIF AU by an existing object (such as RoomInfo or LearningResource). It is intended for use with ResourceBooking, so it can represent any bookable resource; but it is not limited to that usage. While the obvious type of equipment described for booking purposes are things like computers and projectors, the types of equipment that can be booked depends on the educational organisation, and can easily extend to things like vehicles or animals.
SIF_Events are reported for this object.
| Element/@Attribute | Char | Privacy Rating | Description | Type | |
|---|---|---|---|---|---|
| EquipmentInfo | Low | This object represents any resource object that is not already described in SIF AU by an existing object (such as RoomInfo or LearningResource). It is intended for use with ResourceBooking, so it can represent any bookable resource; but it is not limited to that usage. While the obvious type of equipment described for booking purposes are things like computers and projectors, the types of equipment that can be booked depends on the educational organisation, and can easily extend to things like vehicles or animals. | |||
@ | RefId | M | Low | The GUID of the Object | RefIdType |
| Name | M | Low | Name of the equipment. | xs:normalizedString | |
| Description | O | Low | Description of the equipment. | xs:normalizedString | |
| LocalId | M | Low | The Local Id of the equipment. | LocalIdType | |
| AssetNumber | O | Low | Asset number of the equipment; may be distinct from Local Id. | LocalIdType | |
| InvoiceRefId | O | Low | The SIF RefId of the invoice for the equipment. | IdRefType | |
| PurchaseOrderRefId | O | Low | The SIF RefId of the purchase order for the equipment. | IdRefType | |
| EquipmentType | O | Low | Type of equipment. | union of: AUCodeSetsEquipmentTypeType xs:token | |
| SIF_RefId | O | Low | The SIF RefId of the owner/location of the equipment. | IdRefType | |
| @ | SIF_RefObject | M | Low | The type of SIF object that the SIF_RefId element identifies. | values:
|
| LocalCodeList | O | Low | LocalCodeListType | ||
| SIF_Metadata | O | Low | SIF_MetadataType | ||
| SIF_ExtendedElements | O | Low | SIF_ExtendedElementsType |
This object reports the current library status for the requested student or staff member.
The minimum data that the object will return will be the patron's ElectronicId,
the total number of materials that are checked out and overdue,
and the number and amount of any fines that have been assessed to the patron.
When a patron has materials that have been checked out, requested, or are overdue, the object will contain a Transaction element
describing the details of the transaction. Likewise, any fines that have an outstanding balance will also have a Transaction element for the fine.
When a checked out item is returned to the library, it will not appear in the object, even if the item was overdue. Fines that have an outstanding balance will be reported, but when the fine is paid, it will not appear in the object.
The Key - RefId is a resource id, the unique for reference of this object is the Patron Type and Patron Indentifier.
SIF_Events are not reported for this object.
| Element/@Attribute | Char | Privacy Rating | Description | Type | |
|---|---|---|---|---|---|
| LibraryPatronStatus | High | This object reports the current library status for the requested student or staff member. | |||
| @ | RefId | M | Low | A GUID that identifies an instance of this object. This RefId may be a transient value; that is, it SHOULD be generated by the provider at the time the object is provided in a Response message. This value MAY NOT be used in a later Request for the object. | RefIdType |
| LibraryType | M | Low | A library-defined language-independent value that refers to a specific patron type. | xs:string | |
| PatronRefId | C | Low | The SIF wide unique identifier of a Patron. Either RefId or LocalId must be supplied here. | IdRefType | |
| PatronLocalId | C | High | The Local unique identifier of a Patron. Either RefId or LocalId must be supplied here. | LocalIdType | |
| PatronRefObject | M | Low | The type of patron mapped to a SIF supported object. Library automation products work with patrons who could be students or teachers. | values:
| |
| PatronName | O | High | Name of Patron Member, optional, represents the name of the patron only at the time the object was generated. | NameOfRecordType | |
| ElectronicIdList | O | Low | List of electronic identifiers associated with the patron. | ElectronicIdListType | |
| TransactionList | O | High | List of transactions. | LibraryTransactionListType | |
| MessageList | O | High | List of messages for/regarding the patron. | LibraryMessageListType | |
| NumberOfCheckouts | M | High | The total number of items that this patron currently has checked out including overdue items. | xs:unsignedInt | |
| NumberOfHoldItems | O | High | The total number of items that this patron currently has on hold. | xs:unsignedInt | |
| NumberOfOverdues | O | High | The total number of checkouts that are currently overdue. | xs:unsignedInt | |
| NumberOfFines | O | High | The total number of fines currently assessed to this patron. | xs:unsignedInt | |
| FineAmount | O | High | The total monetary amount of the fines that this patron currently owes the library expressed as a positive number. | MonetaryAmountType | |
| NumberOfRefunds | O | High | The total number of refunds currently credited to this patron. | xs:unsignedInt | |
| RefundAmount | O | High | The total monetary amount of the refunds that the library currently owes the patron expressed as a positive number. | MonetaryAmountType | |
| LocalCodeList | O | High | LocalCodeListType | ||
| SIF_Metadata | O | High | SIF_MetadataType | ||
| SIF_ExtendedElements | O | High | SIF_ExtendedElementsType |
This object represents a booking for any resource for a single contiguous time period. This could be either a room or another resource, such as equipment.
SIF_Events are reported for this object.
| Element/@Attribute | Char | Privacy Rating | Description | Type | |
|---|---|---|---|---|---|
| ResourceBooking | Low | This object represents a booking for any resource for a single contiguous time period. This could be either a room or another resource, such as equipment. | |||
| @ | RefId | M | Low | The GUID of the Object | RefIdType |
| ResourceRefId | O | Low | The ID (GUID) of the resource being booked. Provided only if the resource being booked is a SIF object with a GUID. | IdRefType | |
| @ | SIF_RefObject | M | Low | The type of SIF object that the ResourceRefId element identifies. | values:
|
| ResourceLocalId | M | Low | The Local Id of the resource being booked. Provided whether the resource is a SIF object or not. | LocalIdType | |
| StartDateTime | M | Low | Starting date and time for booking. | xs:dateTime | |
| FinishDateTime | M | Low | Finish date and time for booking. | xs:dateTime | |
| FromPeriod | O | Low | Starting period for booking. If specified, the booking is intended to align with bell times. | LocalIdType | |
| ToPeriod | O | Low | Finish period for booking. If specified, the booking is intended to align with bell times. | LocalIdType | |
| Booker | M | Low | Indicates who booked the room. Points to a StaffPersonal record. This will normally (but not necessarily) be the teacher who will be occupying the room. | IdRefType | |
| Reason | O | Low | A free-text explanation of the reason for the room booking. | xs:normalizedString | |
| ScheduledActivityRefId | O | Low | Links the room-booking to a ScheduledActivity. | IdRefType | |
| KeepOld | O | Low | If ScheduledActivity is provided, 'true' means the booker wishes to retain all rooms already specified for the ScheduledActivity. 'false' means that room(s)/resources are now available for other uses. | xs:boolean | |
| LocalCodeList | O | Low | LocalCodeListType | ||
| SIF_Metadata | O | Low | SIF_MetadataType | ||
| SIF_ExtendedElements | O | Low | SIF_ExtendedElementsType |
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 | Privacy Rating | Description | Type | |
|---|---|---|---|---|---|
| RoomInfo | Low | 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 | Low | GUID that identifies this room. | RefIdType |
| SchoolInfoRefId | M | Low | GUID that identifies the school that this room belongs to. | IdRefType | |
| LocalId | O | Low | The locally assigned identifier for the room. | LocalIdType | |
| RoomNumber | M | Low | Room number as presented to the user/application. It is intended to be human readable and user-friendly corresponding to the physical label of the Room. | xs:normalizedString | |
| StaffList | O | Low | A list of GUIDs that identify the staff person assigned to this room (e.g. the homeroom teacher). | StaffListType | |
| Description | O | Low |
Friendly name that can be assigned to the room (e.g. | xs:normalizedString | |
| Building | O | Low | 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 | Low | 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 | Low | Size in square meters. | xs:decimal | |
| Capacity | O | Low | Number of persons (usually students) that this room can hold. | xs:unsignedInt | |
| PhoneNumber | O | Low | Phone number for the room | PhoneNumberType | |
| RoomType | O | Low | Type of room, for use in timetabling. | xs:token | |
| AvailableForTimetable | O | High | Is this Room available to be Timetabled? | AUCodeSetsYesOrNoCategoryType | |
| LocalCodeList | O | Low | LocalCodeListType | ||
| SIF_Metadata | O | Low | SIF_MetadataType | ||
| SIF_ExtendedElements | O | Low | SIF_ExtendedElementsType |
This object provides a broader range of scheduled activities than just normal teaching classes (as covered by SessionInfo).
SIF_Events are reported for this object.
| Element/@Attribute | Char | Privacy Rating | Description | Type | |
|---|---|---|---|---|---|
| ScheduledActivity | Low | This object provides a broader range of scheduled activities than just normal teaching classes (as covered by SessionInfo). | |||
| @ | RefId | M | Low | The GUID of the Object | RefIdType |
| SchoolInfoRefId | M | Low | The ID (GUID) of the school for which this attendance information is being reported. | IdRefType | |
| TimeTableCellRefId | O | Low | An optional Id (GUID) for the timetable cell that this activity is scheduled in. Instances of cyclical classroom sessions will have this element, but one-off events such as excursions will not use this element. | IdRefType | |
| DayId | O | Low | Day Id. | LocalIdType | |
| PeriodId | O | Low | Period Id within the Day Id | LocalIdType | |
| TimeTableRefId | O | Low | The GUID of the TimeTable to which this Cell belongs | IdRefType | |
| ActivityDate | M | Low | Date for which the activity is scheduled. This element is mandatory even if the object is used for preplanning excursions: a tentative or notional date and time should be provided if a finalised date is not available. | xs:date | |
| StartTime | M | Low | Starting time for activity. This element is mandatory even if the object is used for preplanning excursions: a tentative or notional date and time should be provided if a finalised date is not available. | xs:time | |
| FinishTime | M | Low | Finish time for activity. This element is mandatory even if the object is used for preplanning excursions: a tentative or notional date and time should be provided if a finalised date is not available. | xs:time | |
| CellType | O | Low | Type of Lesson/Session eg Teaching, Lunch etc. | xs:normalizedString | |
| TimeTableSubjectRefId | O | Low | Optional to link the GUID of the Subject, if this is a piece of curriculum being scheduled. | IdRefType | |
| TeacherList | O | Low | A listing of the teachers assigned to the activity, and the type of supervision they are credited with. If no teachers are listed, the activity is assumed to be unsupervised. | ScheduledTeacherListType | |
| RoomList | O | Low | List of rooms in which the scheduled activity is held. Used for onsite venues which are represented in the source system as rooms. Can include large venues (ovals, library, etc), if they have been represented as rooms; source system practice varies. | RoomListType | |
| AddressList | O | Low | The address(es) associated with the scheduled activity. | AddressListType | |
| Location | O | Low | Text description of venue. Can be used for either onsite or offsite venues. Can be used if neither RoomList nor AddressList is appropriate or supported by the source system. (E.g. the venue is the oval, which is not represented as a room; the venue is a specific part of the park). If RoomList, AddressList, and Location conflict, the order of priority in interpreting the object is RoomList, then AddressList, then Location. | xs:normalizedString | |
| ActivityType | O | Low | The type of activity undertaken. | AUCodeSetsScheduledActivityTypeType | |
| ActivityName | O | Low | This element is required if this is a one-off event, i.e. there is no TimeTableCellRefId provided, in order for excursions to be uniquely identified. | xs:normalizedString | |
| ActivityComment | O | Low | Allows free-text information, e.g. for excursions. Comment should not be used to identify the location of the venue, since the contents of Comment are open-ended. | xs:normalizedString | |
| StudentList | O | Low | Students who are scheduled to attend the event. Not required for cyclical events, as this would be expected to be provided from TimeTableCell/TeachingGroup instead. | StudentsType | |
| TeachingGroupList | O | Low | Teaching groups which are scheduled to attend the event. Not required for cyclical events, as this would be expected to be provided from TimeTableCell/TeachingGroup instead. | TeachingGroupListType | |
| YearLevels | O | Low | List of year levels offered by the school. | YearLevelsType | |
| Override | O | Low | This flag should be used to indicate whether or not this ScheduledActivity overrides a previous ScheduledActivity. In any initial provisioning this element should NOT be provided. | ScheduledActivityOverrideType | |
| LocalCodeList | O | Low | LocalCodeListType | ||
| SIF_Metadata | O | Low | SIF_MetadataType | ||
| SIF_ExtendedElements | O | Low | SIF_ExtendedElementsType |
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 | Privacy Rating | Description | Type | |
|---|---|---|---|---|---|
| SchoolCourseInfo | Low | 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 | Low | The ID (GUID) that uniquely identifies the school course. | RefIdType |
| SchoolInfoRefId | M | Low | The ID (GUID) that identifies the school where the course is offered. | IdRefType | |
| SchoolLocalId | O | Low | The locally-assigned identifier for this school/campus. | LocalIdType | |
| SchoolYear | C | Low |
School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g. | SchoolYearType | |
| TermInfoRefId | C | Low | The ID (GUID) that uniquely identifies this TermInfo (reportable time period). Either SchoolYear or TermInfoRefId must be provided. | IdRefType | |
| CourseCode | M | Low | School-defined local code for the course. | xs:normalizedString | |
| StateCourseCode | O | Low | State-defined standard course code used to report information about courses. | xs:normalizedString | |
| DistrictCourseCode | O | Low | The corresponding district course code. | xs:normalizedString | |
| SubjectAreaList | O | Low | Subject matter areas. | SubjectAreaListType | |
| CourseTitle | M | Low | Title of the course. | xs:normalizedString | |
| Description | O | Low | Textual description of the course. | xs:normalizedString | |
| InstructionalLevel | O | Low | An indication of the general nature and difficulty of instruction provided. | xs:normalizedString | |
| CourseCredits | O | Low | The number of credits awarded upon course completion. | xs:normalizedString | |
| CoreAcademicCourse | O | Low | Does the course meet the state definition of a core academic course? | AUCodeSetsYesOrNoCategoryType | |
| GraduationRequirement | O | Low | Does the state require that the course be completed for graduation? | AUCodeSetsYesOrNoCategoryType | |
| Department | O | Low | Department with jurisdiction over this course. | xs:normalizedString | |
| CourseContent | O | Low | Description of course content. | xs:normalizedString | |
| LocalCodeList | O | Low | LocalCodeListType | ||
| SIF_Metadata | O | Low | SIF_MetadataType | ||
| SIF_ExtendedElements | O | Low | SIF_ExtendedElementsType |
This object provides information about the section, the specific time period a session of the course meets. Australian Implementations have been using TeachingGroup as a representation of a class;
SIF_Events are reported for this object.
| Element/@Attribute | Char | Privacy Rating | Description | Type | |
|---|---|---|---|---|---|
| SectionInfo | Low | This object provides information about the section, the specific time period a session of the course meets. Australian Implementations have been using TeachingGroup as a representation of a class; | |||
| @ | RefId | M | Low | The Id (GUID) that uniquely identifies this section entity. | RefIdType |
| SchoolCourseInfoRefId | M | Low | The Id (GUID) that identifies the course being taught in this section. | IdRefType | |
| LocalId | M | Low | The locally-assigned identifier for this course section. | LocalIdType | |
| Description | O | Low | Description of the course section. | xs:normalizedString | |
| SchoolYear | C | Low |
School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g. | SchoolYearType | |
| TermInfoRefId | C | Low | The Id (GUID) of the term to which this schedule information relates. Either TermInfoRefId or SchoolYear must be provided. | IdRefType | |
| MediumOfInstruction | O | Low | Medium through which the student receives instructional communication from the teacher. | MediumOfInstructionType | |
| LanguageOfInstruction | O | Low | Language in which the section is taught. | LanguageOfInstructionType | |
| LocationOfInstruction | O | Low | Description of the location in which the section is taught. | LocationOfInstructionType | |
| SummerSchool | O | Low | Is this a summer school assignment? | values:
| |
| SchoolCourseInfoOverride | O | Low | Optional overrides of the course information for this section. | SchoolCourseInfoOverrideType | |
| CourseSectionCode | O | Low | A section code that is linked to a course. This should be a unique identifier within the school year and course (i.e. the class instance number for a course). For example, Algebra I: Section 23 is different from English II: Section 23. | xs:normalizedString | |
| SectionCode | O | Low | A unique identifier of the section for the school year and across courses (i.e. unique across all courses). For example, Algebra I sections range from 00122 to 00140 and English II courses range from 00141 to 00152. | xs:normalizedString | |
| CountForAttendance | O | Low | Indicates if attendance in this section is collected and used in attendance calculations. | values:
| |
| LocalCodeList | O | Low | LocalCodeListType | ||
| SIF_Metadata | O | Low | SIF_MetadataType | ||
| SIF_ExtendedElements | O | Low | SIF_ExtendedElementsType |
This object contains information about a student's enrollment in a section of a course.
SIF_Events are reported for this object.
| Element/@Attribute | Char | Privacy Rating | Description | Type | |
|---|---|---|---|---|---|
| StudentSectionEnrollment | This object contains information about a student's enrollment in a section of a course. | ||||
| @ | RefId | M | The Id (GUID) that uniquely identifies this StudentSectionEnrollment entity. | RefIdType | |
| StudentPersonalRefId | M | The Id (GUID) of the student to whom the enrollment information applies. | IdRefType | ||
| SectionInfoRefId | M | The Id (GUID) of the section in which this student is enrolled. | IdRefType | ||
| SchoolYear | O |
School year for which the information is applicable, expressed as the four-digit year. e.g. | SchoolYearType | ||
| EntryDate | O | Date from when this course section enrollment is valid. | xs:date | ||
| ExitDate | O | The last school calendar day (membership day) the student was enrolled in the course section (inclusive). | xs:date | ||
| LocalCodeList | O | High | LocalCodeListType | ||
| SIF_Metadata | O | High | SIF_MetadataType | ||
| SIF_ExtendedElements | O | High | SIF_ExtendedElementsType |
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 | Privacy Rating | Description | Type | |
|---|---|---|---|---|---|
| TeachingGroup | Medium | 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 | Low | The GUID of the TeachingGroup | RefIdType |
| SchoolYear | M | Low | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007"). | SchoolYearType | |
| LocalId | M | Low | LocalId of the Teaching Group (previously ClassIndicator). | LocalIdType | |
| ShortName | M | Low | Short free format label that describes the group. | xs:normalizedString | |
| LongName | O | Low | Longer description if required. | xs:normalizedString | |
| GroupType | O | Low | Added to allow local implementations to filter on categories of Teaching Group. Where there is a need to filter particular groups based on their types for particular functions; group type provides the means of identifying the type of group such as roll class or subject class for instance and treat them accordingly. | xs:normalizedString | |
| Set | O | Low | Set Number (UK) | xs:normalizedString | |
| Block | O | Low | Block (UK) | xs:normalizedString | |
| CurriculumLevel | O | Low | Assessment Stage eg VELS Level | xs:normalizedString | |
| SchoolInfoRefId | O | Low | GUID of SchoolInfo object this teaching group belongs to. | RefIdType | |
| SchoolLocalId | O | Low | Local School Id. | LocalIdType | |
| SchoolCourseInfoRefId | O | Low | GUID of SchoolCourseInfo object this teaching group is part of. | RefIdType | |
| SchoolCourseLocalId | O | Low | Local Course Id. | LocalIdType | |
| TimeTableSubjectRefId | O | Low | GUID of TimeTableSubject object this teaching group belongs to. | RefIdType | |
| TimeTableSubjectLocalId | O | Low | Local subject Id. | LocalIdType | |
| KeyLearningArea | O | Low | Key Learning Area - map to ACStrand in Union with Religious Studies and Other. | AUCodeSetsACStrandType | |
| Semester | O | Low | Semester, Term, or Quarter subject offered. | xs:unsignedInt | |
| StudentList | O | Medium | List of Students in this Teaching Group | StudentListType | |
| TeacherList | O | Medium | A List of teachers associated with the group - may or may not include the teacher timetabled in the schedule. | TeacherListType | |
| MinClassSize | O | Low | Minimum class size. | xs:integer | |
| MaxClassSize | O | Low | Maximum class size | xs:integer | |
| TeachingGroupPeriodList | O | Low | A List of schedule information that can be published by an SIS which is a subset of information available in the TimeTableCell object. PeriodId or StartTime must be provided. | TeachingGroupPeriodListType | |
| LocalCodeList | O | Medium | LocalCodeListType | ||
| SIF_Metadata | O | Medium | SIF_MetadataType | ||
| SIF_ExtendedElements | O | Medium | SIF_ExtendedElementsType |
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 | Privacy Rating | Description | Type | |
|---|---|---|---|---|---|
| TimeTable | Low | 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 | Low | GUID that identifies this TimeTable object. | RefIdType |
| SchoolInfoRefId | O | Low | Optional, the GUID of the SchoolInfo Object if this object is known in the zone. | IdRefType | |
| SchoolYear | M | Low | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007"). | SchoolYearType | |
| LocalId | O | Low | Local TimeTable ID | LocalIdType | |
| Title | M | Low | Unique Name of the proposed Time Table | xs:normalizedString | |
| DaysPerCycle | M | Low | Max Number of days per Time Table cycle | xs:unsignedInt | |
| PeriodsPerDay | M | Low | Max Number of periods per Time Table Day | xs:unsignedInt | |
| TeachingPeriodsPerDay | O | Low | Teaching periods per day if different to PeriodsPerDay | xs:unsignedInt | |
| SchoolLocalId | O | Low | Optional Local School Id | LocalIdType | |
| SchoolName | O | Low | The school name in plain text. | xs:normalizedString | |
| TimeTableCreationDate | O | Low | Date Schedule was created or last edited. | xs:date | |
| StartDate | O | Low | First day of TimeTable. | xs:date | |
| EndDate | O | Low | Last day of the TimeTable. | xs:date | |
| TimeTableDayList | M | Low | Container for TimeTableDays in Schedule | TimeTableDayListType | |
| LocalCodeList | O | Low | LocalCodeListType | ||
| SIF_Metadata | O | Low | SIF_MetadataType | ||
| SIF_ExtendedElements | O | Low | SIF_ExtendedElementsType |
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 | Privacy Rating | Description | Type | |
|---|---|---|---|---|---|
| TimeTableCell | Low | 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 | Low | The GUID of the TimeTableCell | RefIdType |
| TimeTableRefId | M | Low | The GUID of the TimeTable to which this Cell belongs | IdRefType | |
| TimeTableSubjectRefId | O | Low | The GUID of the Subject that this Cell is scheduling | IdRefType | |
| TeachingGroupRefId | M | Low | The GUID of the TeachingGroup being scheduled | IdRefType | |
| RoomInfoRefId | O | Low | The GUID of the Resource being Scheduled | IdRefType | |
| StaffPersonalRefId | O | Low | The GUID of the Staff Member being Scheduled | IdRefType | |
| TimeTableLocalId | O | Low | Time Table Local Identifier | LocalIdType | |
| SubjectLocalId | O | Low | Subject Local Id | LocalIdType | |
| TeachingGroupLocalId | O | Low | Teaching Group | LocalIdType | |
| RoomNumber | O | Low | Room number as presented to the user/application. | HomeroomNumberType | |
| StaffLocalId | O | Low | Staff LocalId | LocalIdType | |
| DayId | M | Low | Day Id | LocalIdType | |
| PeriodId | M | Low | Period Id within the Day Id | LocalIdType | |
| CellType | M | Low | Type of Lesson/Session eg Teaching, Lunch etc | xs:normalizedString | |
| SchoolInfoRefId | O | Low | Optional, the GUID of the SchoolInfo Object if this object is known in the zone | IdRefType | |
| SchoolLocalId | O | Low | Optional, Local School Id | LocalIdType | |
| TeacherList | O | Low | A listing of the teachers assigned to the activity, and the type of supervision they are credited with. If no teachers are listed, the activity is assumed to be unsupervised. | ScheduledTeacherListType | |
| RoomList | O | Low | List of rooms in which the scheduled activity is held. Used for onsite venues which are represented in the source system as rooms. Can include large venues (ovals, library, etc), if they have been represented as rooms; source system practice varies. | RoomListType | |
| LocalCodeList | O | Low | LocalCodeListType | ||
| SIF_Metadata | O | Low | SIF_MetadataType | ||
| SIF_ExtendedElements | O | Low | SIF_ExtendedElementsType |
This object has been proposed as part of a solution for issues raised with the transmission of timetable information where the software vendor producing the cyclic timetable is not the source of truth for ongoing publishing. e.g. not the endpoint provider.
This object is labelled as EXPERIMENTAL. That means it is subject to changes which may be breaking based on vendor and jurisdiciton implementation, testing and confirmation.
The purpose of this object is to allow a third party software product to submit a cyclic Timetable and all its components as a single payload. The POSTing of this information to an endpoint, allows the endpoint provider to allocate individual resource id's to the components so that the individual entities can be managed by the endpoint provider. e.g. specific TeachingGroupType in this payload will not have a RefId, that will be managed by the endpoint provider if that information is to be re-published separately.
SIF_Events are reported for this object.
| Element/@Attribute | Char | Privacy Rating | Description | Type | |
|---|---|---|---|---|---|
| TimeTableContainer | Medium | This object has been proposed as part of a solution for issues raised with the transmission of timetable information where the software vendor producing the cyclic timetable is not the source of truth for ongoing publishing. e.g. not the endpoint provider. This object is labelled as EXPERIMENTAL. That means it is subject to changes which may be breaking based on vendor and jurisdiciton implementation, testing and confirmation. The purpose of this object is to allow a third party software product to submit a cyclic Timetable and all its components as a single payload. The POSTing of this information to an endpoint, allows the endpoint provider to allocate individual resource id's to the components so that the individual entities can be managed by the endpoint provider. e.g. specific TeachingGroupType in this payload will not have a RefId, that will be managed by the endpoint provider if that information is to be re-published separately. | |||
| @ | RefId | M | Low | GUID that identifies this TimeTable Container. | RefIdType |
| TimeTableSchedule | O | Low | TimeTableScheduleType | ||
| TimeTableScheduleCellList | O | Low | All the TimeTable Cells that belong to this TimeTable. | TimeTableScheduleCellListType | |
| TeachingGroupScheduleList | O | Low | All the Teaching Groups that belong to this TimeTable. | TeachingGroupScheduleType | |
| LocalCodeList | O | Low | LocalCodeListType | ||
| SIF_Metadata | O | Low | SIF_MetadataType | ||
| SIF_ExtendedElements | O | Low | SIF_ExtendedElementsType |
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 | Privacy Rating | Description | Type | |
|---|---|---|---|---|---|
| TimeTableSubject | Low | 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 | Low | GUID that identifies this TimeTableSubject. | RefIdType |
| SubjectLocalId | M | Low | SubjectLocalID - Distinct piece of curriculum that is to be scheduled. | LocalIdType | |
| AcademicYear | C | Low | Subject Year Level. Either AcademicYear or AcademicYearRange must be provided. | YearLevelType | |
| AcademicYearRange | C | Low | Range of Academic Years subject spans. Either AcademicYear or AcademicYearRange must be provided. | YearRangeType | |
| CourseLocalId | O | Low | Local Course Id, if associated with a Course. | LocalIdType | |
| SchoolCourseInfoRefId | O | Low | The GUID of the SchoolCourseInfo object. | RefIdType | |
| Faculty | O | Low | Faculty | xs:normalizedString | |
| SubjectShortName | O | Low | SubjectShortName | xs:normalizedString | |
| SubjectLongName | M | Low | SubjectLongName | xs:normalizedString | |
| SubjectType | O | Low | Core or Elective or ? | xs:normalizedString | |
| ProposedMaxClassSize | O | Low | Suggested maximum class size for this subject. | xs:decimal | |
| ProposedMinClassSize | O | Low | Suggested minimum class size for this subject. | xs:decimal | |
| SchoolInfoRefId | O | Low | Optional the GUID of the SchoolInfo Object if this object is known in the zone. | IdRefType | |
| SchoolLocalId | O | Low | Optional Local School Id | LocalIdType | |
| Semester | O | Low | Semester, Term, or Quarter subject offered. | xs:unsignedInt | |
| SchoolYear | O | Low | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007"). | SchoolYearType | |
| OtherCodeList | O | Low | Any other codes this subject is known by; eg VASS code for VCE in Vic. | OtherCodeListType | |
| LocalCodeList | O | Low | LocalCodeListType | ||
| SIF_Metadata | O | Low | SIF_MetadataType | ||
| SIF_ExtendedElements | O | Low | SIF_ExtendedElementsType |