3.11 Timetabling and Resource Scheduling

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.

3.11.1 EquipmentInfo

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.

EquipmentInfo
Figure 3.11.1-1: EquipmentInfo EquipmentInfo RefId Name Description LocalId AssetNumber InvoiceRefId PurchaseOrderRefId EquipmentType SIF_RefId SIF_RefObject LocalCodeList SIF_Metadata SIF_ExtendedElements
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
@
key
RefIdMLowThe GUID of the Object RefIdType
 NameMLow

Name of the equipment.

 
xs:normalizedString
 DescriptionOLow

Description of the equipment.

 
xs:normalizedString
 LocalIdMLow

The Local Id of the equipment.

 
LocalIdType
 AssetNumberOLow

Asset number of the equipment; may be distinct from Local Id.

 
LocalIdType
 InvoiceRefIdOLow

The SIF RefId of the invoice for the equipment.

 
IdRefType
 PurchaseOrderRefIdOLow

The SIF RefId of the purchase order for the equipment.

 
IdRefType
 EquipmentTypeOLow

Type of equipment.

 
union of:

AUCodeSetsEquipmentTypeType
xs:token
 SIF_RefIdOLow

The SIF RefId of the owner/location of the equipment.

 
IdRefType
@SIF_RefObjectMLow

The type of SIF object that the SIF_RefId element identifies.

 
values:
SchoolInfo
RoomInfo
LEAInfo
other
 LocalCodeListOLow LocalCodeListType
 SIF_MetadataOLow SIF_MetadataType
 SIF_ExtendedElementsOLow SIF_ExtendedElementsType
Table 3.11.1-1: EquipmentInfo
{ "EquipmentInfo": { "RefId": "B5739375-800A-C4CC-6385-0BB2754114AA", "Name": "Overhead Projector 3", "LocalId": "OHP3", "EquipmentType": "OverheadProjector", "SIF_RefId": { "SIF_RefObject": "SchoolInfo", "value": "B7A34E56-1C97-345C-0A4E-11BB112B2753" } } }
<EquipmentInfo RefId="B5739375-800A-C4CC-6385-0BB2754114AA"> <Name>Overhead Projector 3</Name> <LocalId>OHP3</LocalId> <EquipmentType>OverheadProjector</EquipmentType> <SIF_RefId SIF_RefObject="SchoolInfo">B7A34E56-1C97-345C-0A4E-11BB112B2753</SIF_RefId> </EquipmentInfo>
Example 3.11.1-1: EquipmentInfo Example

3.11.2 LibraryPatronStatus

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.

LibraryPatronStatus
Figure 3.11.2-1: LibraryPatronStatus LibraryPatronStatus RefId LibraryType PatronRefId PatronLocalId PatronRefObject PatronName ElectronicIdList TransactionList MessageList NumberOfCheckouts NumberOfHoldItems NumberOfOverdues NumberOfFines FineAmount NumberOfRefunds RefundAmount LocalCodeList SIF_Metadata SIF_ExtendedElements
 Element/@AttributeCharPrivacy RatingDescriptionType
 LibraryPatronStatus High

This object reports the current library status for the requested student or staff member.

 
 
@RefIdMLow

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
 LibraryTypeMLow

A library-defined language-independent value that refers to a specific patron type.

 
xs:string
 PatronRefIdCLow

The SIF wide unique identifier of a Patron. Either RefId or LocalId must be supplied here.

 
IdRefType
 PatronLocalIdCHigh

The Local unique identifier of a Patron. Either RefId or LocalId must be supplied here.

 
LocalIdType
 PatronRefObjectMLow

The type of patron mapped to a SIF supported object. Library automation products work with patrons who could be students or teachers.

 
values:
StudentPersonal
Student Patron
StaffPersonal
Staff Patron
 PatronNameOHigh

Name of Patron Member, optional, represents the name of the patron only at the time the object was generated.

 
NameOfRecordType
 ElectronicIdListOLow

List of electronic identifiers associated with the patron.

 
ElectronicIdListType
 TransactionListOHigh

List of transactions.

 
LibraryTransactionListType
 MessageListOHigh

List of messages for/regarding the patron.

 
LibraryMessageListType
 NumberOfCheckoutsMHigh

The total number of items that this patron currently has checked out including overdue items.

 
xs:unsignedInt
 NumberOfHoldItemsOHigh

The total number of items that this patron currently has on hold.

 
xs:unsignedInt
 NumberOfOverduesOHigh

The total number of checkouts that are currently overdue.

 
xs:unsignedInt
 NumberOfFinesOHigh

The total number of fines currently assessed to this patron.

 
xs:unsignedInt
 FineAmountOHigh

The total monetary amount of the fines that this patron currently owes the library expressed as a positive number.

 
MonetaryAmountType
 NumberOfRefundsOHigh

The total number of refunds currently credited to this patron.

 
xs:unsignedInt
 RefundAmountOHigh

The total monetary amount of the refunds that the library currently owes the patron expressed as a positive number.

 
MonetaryAmountType
 LocalCodeListOHigh LocalCodeListType
 SIF_MetadataOHigh SIF_MetadataType
 SIF_ExtendedElementsOHigh SIF_ExtendedElementsType
Table 3.11.2-1: LibraryPatronStatus
{ "LibraryPatronStatus": { "RefId": "D3E34B35-9D75-101A-8C3D-00AA001A1652", "LibraryType": "S", "PatronRefId": "5DE34B35-9D75-101A-8C3D-00AA001A1652", "PatronLocalId": "MAR01", "PatronRefObject": "StudentPersonal", "ElectronicIdList": { "ElectronicId": [ { "Type": "01", "value": "P 7676" }, { "Type": "02", "value": "201906300007676JJI" }, { "Type": "03", "value": "1234" }, { "Type": "04", "value": "0EF3098055921FEDC008FEEB" } ] }, "TransactionList": { "Transaction": [ { "ItemInfo": { "Type": "LibraryMaterial", "Title": "Redwall", "Author": "Brian Jacques", "ElectronicId": { "Type": "01", "value": "T 311" }, "CallNumber": "YA JACQ", "Cost": "6.99", "ReplacementCost": "7.5" }, "CheckoutInfo": { "ReturnBy": "2019-01-05T15:59:59+11:00" }, "FineInfoList": { "FineInfo": [ { "Type": "Overdue", "Assessed": "2019-01-07T05:19:00+11:00", "Description": "ESTIMATED FINE FOR OVERDUE ITEM", "Amount": { "value": 0.5 } } ] } }, { "ItemInfo": { "Type": "LibraryMaterial", "Title": "Mossflower", "Author": "Brian Jacques", "ElectronicId": { "Type": "01", "value": "T 1211" }, "CallNumber": "YA JACQ", "Cost": "7.49" }, "HoldInfoList": { "HoldInfo": [ { "Type": "Ready", "DatePlaced": "2018-12-18", "DateNeeded": "2019-01-16", "ReservationExpiry": "2019-01-31", "MadeAvailable": "2019-01-05", "Expires": "2019-02-01" } ] } }, { "ItemInfo": { "Type": "LibraryMaterial", "Title": "The Bellmaker", "Author": "Brian Jacques" }, "HoldInfoList": { "HoldInfo": [ { "Type": "NotReady", "DatePlaced": "2018-12-18" } ] } }, { "ItemInfo": { "Type": "Textbook", "Title": "Passport to Algebra and Geometry", "Author": "Larson, Boswell, Kanold and Stiff", "ElectronicId": { "Type": "01", "value": "98770000178215" }, "Cost": "57.18" }, "CheckoutInfo": { "CheckedOutOn": "2019-05-16T14:59:59+10:00", "ReturnBy": "2019-06-16T14:59:59+10:00" } }, { "ItemInfo": { "Type": "LibraryMaterial", "Title": "Harry Potter and the Goblet of Fire", "Author": "JK Rowlings", "ElectronicId": { "Type": "01", "value": "T 99321" } }, "FineInfoList": { "FineInfo": [ { "Type": "Refund", "Assessed": "2019-01-03T01:29:00+11:00", "Description": "Lost item returned", "Amount": { "value": 28.9 } } ] } }, { "FineInfoList": { "FineInfo": [ { "Type": "Other", "Assessed": "2019-01-05T02:14:00+11:00", "Description": "Running in library", "Amount": { "value": 1.0 }, "Reference": "42" } ] } } ] }, "MessageList": { "Message": [ { "Priority": "Normal", "Text": "This is a normal message." }, { "Priority": "Urgent", "Sent": "2019-01-13T06:01:00+11:00", "Text": "This is an URGENT message!" } ] }, "NumberOfCheckouts": 1, "NumberOfHoldItems": "2", "NumberOfOverdues": 1, "NumberOfFines": 1, "FineAmount": { "value": 1.0 }, "NumberOfRefunds": 1, "RefundAmount": { "value": 28.9 } } }
<LibraryPatronStatus RefId="D3E34B35-9D75-101A-8C3D-00AA001A1652"> <LibraryType>S</LibraryType> <PatronRefId>5DE34B35-9D75-101A-8C3D-00AA001A1652</PatronRefId> <PatronLocalId>MAR01</PatronLocalId> <PatronRefObject>StudentPersonal</PatronRefObject> <ElectronicIdList> <ElectronicId Type="01">P 7676</ElectronicId> <ElectronicId Type="02">201906300007676JJI</ElectronicId> <ElectronicId Type="03">1234</ElectronicId> <ElectronicId Type="04">0EF3098055921FEDC008FEEB</ElectronicId> </ElectronicIdList> <TransactionList> <Transaction> <ItemInfo Type="LibraryMaterial"> <Title>Redwall</Title> <Author>Brian Jacques</Author> <ElectronicId Type="01">T 311</ElectronicId> <CallNumber>YA JACQ</CallNumber> <Cost>6.99</Cost> <ReplacementCost>7.5</ReplacementCost> </ItemInfo> <CheckoutInfo> <ReturnBy>2019-01-04T23:59:59-05:00</ReturnBy> </CheckoutInfo> <FineInfoList> <FineInfo Type="Overdue"> <Assessed>2019-01-06T13:19:00-05:00</Assessed> <Description>ESTIMATED FINE FOR OVERDUE ITEM</Description> <Amount>0.50</Amount> </FineInfo> </FineInfoList> </Transaction> <Transaction> <ItemInfo Type="LibraryMaterial"> <Title>Mossflower</Title> <Author>Brian Jacques</Author> <ElectronicId Type="01">T 1211</ElectronicId> <CallNumber>YA JACQ</CallNumber> <Cost>7.49</Cost> </ItemInfo> <HoldInfoList> <HoldInfo Type="Ready"> <DatePlaced>2018-12-18</DatePlaced> <DateNeeded>2019-01-16</DateNeeded> <ReservationExpiry>2019-01-31</ReservationExpiry> <MadeAvailable>2019-01-05</MadeAvailable> <Expires>2019-02-01</Expires> </HoldInfo> </HoldInfoList> </Transaction> <Transaction> <ItemInfo Type="LibraryMaterial"> <Title>The Bellmaker</Title> <Author>Brian Jacques</Author> </ItemInfo> <HoldInfoList> <HoldInfo Type="NotReady"> <DatePlaced>2018-12-18</DatePlaced> </HoldInfo> </HoldInfoList> </Transaction> <Transaction> <ItemInfo Type="Textbook"> <Title>Passport to Algebra and Geometry</Title> <Author>Larson, Boswell, Kanold and Stiff</Author> <ElectronicId Type="01">98770000178215</ElectronicId> <Cost>57.18</Cost> </ItemInfo> <CheckoutInfo> <CheckedOutOn>2019-05-15T23:59:59-05:00</CheckedOutOn> <ReturnBy>2019-06-15T23:59:59-05:00</ReturnBy> </CheckoutInfo> </Transaction> <Transaction> <ItemInfo Type="LibraryMaterial"> <Title>Harry Potter and the Goblet of Fire</Title> <Author>JK Rowlings</Author> <ElectronicId Type="01">T 99321</ElectronicId> </ItemInfo> <FineInfoList> <FineInfo Type="Refund"> <Assessed>2019-01-02T09:29:00-05:00</Assessed> <Description>Lost item returned</Description> <Amount>28.90</Amount> </FineInfo> </FineInfoList> </Transaction> <Transaction> <FineInfoList> <FineInfo Type="Other"> <Assessed>2019-01-04T10:14:00-05:00</Assessed> <Description>Running in library</Description> <Amount>1.00</Amount> <Reference>42</Reference> </FineInfo> </FineInfoList> </Transaction> </TransactionList> <MessageList> <Message Priority="Normal"> <Text>This is a normal message.</Text> </Message> <Message Priority="Urgent"> <Sent>2019-01-12T14:01:00-05:00</Sent> <Text>This is an URGENT message!</Text> </Message> </MessageList> <NumberOfCheckouts>1</NumberOfCheckouts> <NumberOfHoldItems>2</NumberOfHoldItems> <NumberOfOverdues>1</NumberOfOverdues> <NumberOfFines>1</NumberOfFines> <FineAmount>1.00</FineAmount> <NumberOfRefunds>1</NumberOfRefunds> <RefundAmount>28.90</RefundAmount> </LibraryPatronStatus>
Example 3.11.2-1: LibraryPatronStatus

3.11.3 ResourceBooking

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.

ResourceBooking
Figure 3.11.3-1: ResourceBooking ResourceBooking RefId ResourceRefId SIF_RefObject ResourceLocalId StartDateTime FinishDateTime FromPeriod ToPeriod Booker Reason ScheduledActivityRefId KeepOld LocalCodeList SIF_Metadata SIF_ExtendedElements
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
@
key
RefIdMLowThe GUID of the Object RefIdType
 ResourceRefIdOLow

The ID (GUID) of the resource being booked. Provided only if the resource being booked is a SIF object with a GUID.

 
IdRefType
@SIF_RefObjectMLow

The type of SIF object that the ResourceRefId element identifies.

 
values:
RoomInfo
EquipmentInfo
LearningResource
 ResourceLocalIdMLow

The Local Id of the resource being booked. Provided whether the resource is a SIF object or not.

 
LocalIdType
 StartDateTimeMLow

Starting date and time for booking.

 
xs:dateTime
 FinishDateTimeMLow

Finish date and time for booking.

 
xs:dateTime
 FromPeriodOLow

Starting period for booking. If specified, the booking is intended to align with bell times.

 
LocalIdType
 ToPeriodOLow

Finish period for booking. If specified, the booking is intended to align with bell times.

 
LocalIdType
 BookerMLow

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
 ReasonOLow

A free-text explanation of the reason for the room booking.

 
xs:normalizedString
 ScheduledActivityRefIdOLow

Links the room-booking to a ScheduledActivity.

 
IdRefType
 KeepOldOLow

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
 LocalCodeListOLow LocalCodeListType
 SIF_MetadataOLow SIF_MetadataType
 SIF_ExtendedElementsOLow SIF_ExtendedElementsType
Table 3.11.3-1: ResourceBooking
{ "ResourceBooking": { "RefId": "B5739375-800A-C4CC-6385-0BB2754114AA", "ResourceRefId": { "SIF_RefObject": "LearningResource", "value": "B7A34E56-1C97-345C-0A4E-11BB112B2753" }, "ResourceLocalId": "ZXY789", "StartDateTime": "2011-01-01T16:30:00", "FinishDateTime": "2011-01-01T17:30:00", "FromPeriod": "3", "ToPeriod": "3", "Booker": "98157AA0-13BA-8C3D-00AA-012B359D7512", "ScheduledActivityRefId": "A75A0010-1A8C-301D-02E3-A05B359D0A00", "KeepOld": false } }
<ResourceBooking RefId="B5739375-800A-C4CC-6385-0BB2754114AA"> <ResourceRefId SIF_RefObject="LearningResource">B7A34E56-1C97-345C-0A4E-11BB112B2753</ResourceRefId> <ResourceLocalId>ZXY789</ResourceLocalId> <StartDateTime>2011-01-01T16:30:00</StartDateTime> <FinishDateTime>2011-01-01T17:30:00</FinishDateTime> <FromPeriod>3</FromPeriod> <ToPeriod>3</ToPeriod> <Booker>98157AA0-13BA-8C3D-00AA-012B359D7512</Booker> <ScheduledActivityRefId>A75A0010-1A8C-301D-02E3-A05B359D0A00</ScheduledActivityRefId> <KeepOld>false</KeepOld> </ResourceBooking>
Example 3.11.3-1: ResourceBooking Example

3.11.4 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.

SIF_Events are reported for this object.

RoomInfo
Figure 3.11.4-1: RoomInfo RoomInfo RefId SchoolInfoRefId LocalId RoomNumber StaffList Description Building HomeroomNumber Size Capacity PhoneNumber RoomType AvailableForTimetable LocalCodeList SIF_Metadata SIF_ExtendedElements
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
@
key
RefIdMLow

GUID that identifies this room.

 
RefIdType
 SchoolInfoRefIdMLow

GUID that identifies the school that this room belongs to.

 
IdRefType
 LocalIdOLow

The locally assigned identifier for the room.

 
LocalIdType
 RoomNumberMLow

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
 StaffListOLow

A list of GUIDs that identify the staff person assigned to this room (e.g. the homeroom teacher).

 
StaffListType
 DescriptionOLow

Friendly name that can be assigned to the room (e.g. Staff Cafeteria).

 
xs:normalizedString
 BuildingOLow

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
 HomeroomNumberOLow

When a room is designated as a homeroom it may have a different number. Usually blank when room is not a homeroom.

 
xs:normalizedString
 SizeOLow

Size in square meters.

 
xs:decimal
 CapacityOLow

Number of persons (usually students) that this room can hold.

 
xs:unsignedInt
 PhoneNumberOLow

Phone number for the room

 
PhoneNumberType
 RoomTypeOLow

Type of room, for use in timetabling.

 
xs:token
 AvailableForTimetableOHigh

Is this Room available to be Timetabled?

 
AUCodeSetsYesOrNoCategoryType
 LocalCodeListOLow LocalCodeListType
 SIF_MetadataOLow SIF_MetadataType
 SIF_ExtendedElementsOLow SIF_ExtendedElementsType
Table 3.11.4-1: RoomInfo
{ "RoomInfo": { "RefId": "D3E34B35-9D75-101A-8C3D-00AA001A1652", "SchoolInfoRefId": "A2E35B35-9D75-101A-8C3D-00AA001A0000", "RoomNumber": "101", "StaffList": { "StaffPersonalRefId": [ "A8C3A2E3-5B35-9D75-101D-00AA001A0000" ] }, "Description": "Room 101", "Building": "Main A", "HomeroomNumber": "10-HR-A", "Size": 400, "Capacity": 35, "PhoneNumber": { "Type": "0096", "Number": "(02) 9555-1234" }, "AvailableForTimetable": "Y" } }
<RoomInfo RefId="D3E34B35-9D75-101A-8C3D-00AA001A1652"> <SchoolInfoRefId>A2E35B35-9D75-101A-8C3D-00AA001A0000</SchoolInfoRefId> <RoomNumber>101</RoomNumber> <StaffList> <StaffPersonalRefId>A8C3A2E3-5B35-9D75-101D-00AA001A0000</StaffPersonalRefId> </StaffList> <Description>Room 101</Description> <Building>Main A</Building> <HomeroomNumber>10-HR-A</HomeroomNumber> <Size>400</Size> <Capacity>35</Capacity> <PhoneNumber Type="0096"> <Number>(02) 9555-1234</Number> </PhoneNumber> <AvailableForTimetable>Y</AvailableForTimetable> </RoomInfo>
Example 3.11.4-1: RoomInfo Example

3.11.5 ScheduledActivity

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.

ScheduledActivity
Figure 3.11.5-1: ScheduledActivity ScheduledActivity RefId SchoolInfoRefId TimeTableCellRefId DayId PeriodId TimeTableRefId ActivityDate StartTime FinishTime CellType TimeTableSubjectRefId TeacherList RoomList AddressList Location ActivityType ActivityName ActivityComment StudentList TeachingGroupList YearLevels Override LocalCodeList SIF_Metadata SIF_ExtendedElements
 Element/@AttributeCharPrivacy RatingDescriptionType
 ScheduledActivity Low

This object provides a broader range of scheduled activities than just normal teaching classes (as covered by SessionInfo).

 
 
@
key
RefIdMLowThe GUID of the Object RefIdType
 SchoolInfoRefIdMLow

The ID (GUID) of the school for which this attendance information is being reported.

 
IdRefType
 TimeTableCellRefIdOLow

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
 DayIdOLow

Day Id.

 
LocalIdType
 PeriodIdOLow

Period Id within the Day Id

 
LocalIdType
 TimeTableRefIdOLow

The GUID of the TimeTable to which this Cell belongs

 
IdRefType
 ActivityDateMLow

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
 StartTimeMLow

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
 FinishTimeMLow

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
 CellTypeOLow

Type of Lesson/Session eg Teaching, Lunch etc.

 
xs:normalizedString
 TimeTableSubjectRefIdOLow

Optional to link the GUID of the Subject, if this is a piece of curriculum being scheduled.

 
IdRefType
 TeacherListOLow

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
 RoomListOLow

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
 AddressListOLow

The address(es) associated with the scheduled activity.

 
AddressListType
 LocationOLow

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
 ActivityTypeOLow

The type of activity undertaken.

 
AUCodeSetsScheduledActivityTypeType
 ActivityNameOLow

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
 ActivityCommentOLow

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
 StudentListOLow

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
 TeachingGroupListOLow

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
 YearLevelsOLow

List of year levels offered by the school.

 
YearLevelsType
 OverrideOLow

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
 LocalCodeListOLow LocalCodeListType
 SIF_MetadataOLow SIF_MetadataType
 SIF_ExtendedElementsOLow SIF_ExtendedElementsType
Table 3.11.5-1: ScheduledActivity
{ "ScheduledActivity": { "RefId": "BD3E34B3-59D7-5101-A8C3-D00AA001A165", "SchoolInfoRefId": "B7A34E56-1C97-345C-0A4E-11BB112B2753", "TimeTableCellRefId": "FDF05286-9094-4405-96B3-D6CC0ED5F00B", "DayId": "1", "TimeTableRefId": "2A7F0D96-3E99-4B83-A958-690C360A36C2", "ActivityDate": "2014-10-10", "StartTime": "12:05:00", "FinishTime": "13:30:00", "TeacherList": { "TeacherCover": [ { "StaffPersonalRefId": "98157AA0-13BA-8C3D-00AA-012B359D7512", "StaffLocalId": "US8923", "StartTime": "12:05:00", "FinishTime": "13:00:00", "Credit": "In-Lieu", "Supervision": "MinimalSupervision", "Weighting": 0.5 }, { "StaffPersonalRefId": "A75A0010-1A8C-301D-02E3-A05B359D0A00", "StaffLocalId": "ZY3213", "StartTime": "13:00:00", "FinishTime": "13:30:00", "Credit": "Extra", "Supervision": "MinimalSupervision", "Weighting": 0.5 } ] }, "RoomList": { "RoomInfoRefId": [ "11737EA4-301C-ADCA-75C8-7214A7C46BDB" ] }, "ActivityType": "Incursion", "StudentList": { "StudentPersonalRefId": [ "FAE9D90A-38F8-4B72-9C92-F868CB63C9F3" ] }, "TeachingGroupList": { "TeachingGroupRefId": [ "EB79C3D1-FF19-11D7-8513-8B604A511DAD", "B2345163-8474-6B38-7459-000F84723A00" ] } } }
<ScheduledActivity RefId="BD3E34B3-59D7-5101-A8C3-D00AA001A165"> <SchoolInfoRefId>B7A34E56-1C97-345C-0A4E-11BB112B2753</SchoolInfoRefId> <TimeTableCellRefId>FDF05286-9094-4405-96B3-D6CC0ED5F00B</TimeTableCellRefId> <DayId>1</DayId> <TimeTableRefId>2A7F0D96-3E99-4B83-A958-690C360A36C2</TimeTableRefId> <ActivityDate>2014-10-10</ActivityDate> <StartTime>12:05:00</StartTime> <FinishTime>13:30:00</FinishTime> <TeacherList> <TeacherCover> <StaffPersonalRefId>98157AA0-13BA-8C3D-00AA-012B359D7512</StaffPersonalRefId> <StaffLocalId>US8923</StaffLocalId> <StartTime>12:05:00</StartTime> <FinishTime>13:00:00</FinishTime> <Credit>In-Lieu</Credit> <Supervision>MinimalSupervision</Supervision> <Weighting>0.5</Weighting> </TeacherCover> <TeacherCover> <StaffPersonalRefId>A75A0010-1A8C-301D-02E3-A05B359D0A00</StaffPersonalRefId> <StaffLocalId>ZY3213</StaffLocalId> <StartTime>13:00:00</StartTime> <FinishTime>13:30:00</FinishTime> <Credit>Extra</Credit> <Supervision>MinimalSupervision</Supervision> <Weighting>0.5</Weighting> </TeacherCover> </TeacherList> <RoomList> <RoomInfoRefId>11737EA4-301C-ADCA-75C8-7214A7C46BDB</RoomInfoRefId> </RoomList> <ActivityType>Incursion</ActivityType> <StudentList> <StudentPersonalRefId>FAE9D90A-38F8-4B72-9C92-F868CB63C9F3</StudentPersonalRefId> </StudentList> <TeachingGroupList> <TeachingGroupRefId>EB79C3D1-FF19-11D7-8513-8B604A511DAD</TeachingGroupRefId> <TeachingGroupRefId>B2345163-8474-6B38-7459-000F84723A00</TeachingGroupRefId> </TeachingGroupList> </ScheduledActivity>
Example 3.11.5-1: ScheduledActivity Example

3.11.6 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.

SIF_Events are reported for this object.

SchoolCourseInfo
Figure 3.11.6-1: SchoolCourseInfo SchoolCourseInfo RefId SchoolInfoRefId SchoolLocalId SchoolYear TermInfoRefId CourseCode StateCourseCode DistrictCourseCode SubjectAreaList CourseTitle Description InstructionalLevel CourseCredits CoreAcademicCourse GraduationRequirement Department CourseContent LocalCodeList SIF_Metadata SIF_ExtendedElements
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
@
key
RefIdMLow

The ID (GUID) that uniquely identifies the school course.

 
RefIdType
 SchoolInfoRefIdMLow

The ID (GUID) that identifies the school where the course is offered.

 
IdRefType
 SchoolLocalIdOLow

The locally-assigned identifier for this school/campus.

 
LocalIdType
 SchoolYearCLow

School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g. 2007).

 
SchoolYearType
 TermInfoRefIdCLow

The ID (GUID) that uniquely identifies this TermInfo (reportable time period). Either SchoolYear or TermInfoRefId must be provided.

 
IdRefType
 CourseCodeMLow

School-defined local code for the course.

 
xs:normalizedString
 StateCourseCodeOLow

State-defined standard course code used to report information about courses.

 
xs:normalizedString
 DistrictCourseCodeOLow

The corresponding district course code.

 
xs:normalizedString
 SubjectAreaListOLow

Subject matter areas.

 
SubjectAreaListType
 CourseTitleMLow

Title of the course.

 
xs:normalizedString
 DescriptionOLow

Textual description of the course.

 
xs:normalizedString
 InstructionalLevelOLow

An indication of the general nature and difficulty of instruction provided.

 
xs:normalizedString
 CourseCreditsOLow

The number of credits awarded upon course completion.

 
xs:normalizedString
 CoreAcademicCourseOLow

Does the course meet the state definition of a core academic course?

 
AUCodeSetsYesOrNoCategoryType
 GraduationRequirementOLow

Does the state require that the course be completed for graduation?

 
AUCodeSetsYesOrNoCategoryType
 DepartmentOLow

Department with jurisdiction over this course.

 
xs:normalizedString
 CourseContentOLow

Description of course content.

 
xs:normalizedString
 LocalCodeListOLow LocalCodeListType
 SIF_MetadataOLow SIF_MetadataType
 SIF_ExtendedElementsOLow SIF_ExtendedElementsType
Table 3.11.6-1: SchoolCourseInfo
{ "SchoolCourseInfo": { "RefId": "9D75101A-8C3D-00AA-001A-0000A2E35B35", "SchoolInfoRefId": "101A8C3D-00AA-001A-0000-A2E35B359D75", "SchoolYear": "2006", "CourseCode": "CS101", "StateCourseCode": "08-001", "DistrictCourseCode": "CS101", "SubjectAreaList": { "SubjectArea": [ { "Code": "Graphic Arts" } ] }, "CourseTitle": "Gif, JPeg, or Png: What's the Difference?", "Description": "Explore the various types of files related to graphic arts.", "InstructionalLevel": "0571", "CourseCredits": "2", "CoreAcademicCourse": "N", "GraduationRequirement": "N" } }
<SchoolCourseInfo RefId="9D75101A-8C3D-00AA-001A-0000A2E35B35"> <SchoolInfoRefId>101A8C3D-00AA-001A-0000-A2E35B359D75</SchoolInfoRefId> <SchoolYear>2006</SchoolYear> <CourseCode>CS101</CourseCode> <StateCourseCode>08-001</StateCourseCode> <DistrictCourseCode>CS101</DistrictCourseCode> <SubjectAreaList> <SubjectArea> <Code>Graphic Arts</Code> </SubjectArea> </SubjectAreaList> <CourseTitle>Gif, JPeg, or Png: What's the Difference?</CourseTitle> <Description>Explore the various types of files related to graphic arts.</Description> <InstructionalLevel>0571</InstructionalLevel> <CourseCredits>2</CourseCredits> <CoreAcademicCourse>N</CoreAcademicCourse> <GraduationRequirement>N</GraduationRequirement> </SchoolCourseInfo>
Example 3.11.6-1: SchoolCourseInfo Example

3.11.7 SectionInfo

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.

SectionInfo
Figure 3.11.7-1: SectionInfo SectionInfo RefId SchoolCourseInfoRefId LocalId Description SchoolYear TermInfoRefId MediumOfInstruction LanguageOfInstruction LocationOfInstruction SummerSchool SchoolCourseInfoOverride CourseSectionCode SectionCode CountForAttendance LocalCodeList SIF_Metadata SIF_ExtendedElements
 Element/@AttributeCharPrivacy RatingDescriptionType
 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;

 
 
@
key
RefIdMLow

The Id (GUID) that uniquely identifies this section entity.

 
RefIdType
 SchoolCourseInfoRefIdMLow

The Id (GUID) that identifies the course being taught in this section.

 
IdRefType
 LocalIdMLow

The locally-assigned identifier for this course section.

 
LocalIdType
 DescriptionOLow

Description of the course section.

 
xs:normalizedString
 SchoolYearCLow

School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g. 2013 for the 2013 school year). Either SchoolYear or TermInfoRefId must be provided.

 
SchoolYearType
 TermInfoRefIdCLow

The Id (GUID) of the term to which this schedule information relates. Either TermInfoRefId or SchoolYear must be provided.

 
IdRefType
 MediumOfInstructionOLow

Medium through which the student receives instructional communication from the teacher.

 
MediumOfInstructionType
 LanguageOfInstructionOLow

Language in which the section is taught.

 
LanguageOfInstructionType
 LocationOfInstructionOLow

Description of the location in which the section is taught.

 
LocationOfInstructionType
 SummerSchoolOLow

Is this a summer school assignment?

 
values:
Yes
No
 SchoolCourseInfoOverrideOLow

Optional overrides of the course information for this section.

 
SchoolCourseInfoOverrideType
 CourseSectionCodeOLow

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
 SectionCodeOLow

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
 CountForAttendanceOLow

Indicates if attendance in this section is collected and used in attendance calculations.

 
values:
Yes
No
 LocalCodeListOLow LocalCodeListType
 SIF_MetadataOLow SIF_MetadataType
 SIF_ExtendedElementsOLow SIF_ExtendedElementsType
Table 3.11.7-1: SectionInfo
{ "SectionInfo": { "RefId": "D3E34B35-9D75-101A-8C3D-00AA001A1652", "SchoolCourseInfoRefId": "101A8C3D-00AA-001A-0000-A2E35B359D75", "LocalId": "287-1", "SchoolYear": "2013", "MediumOfInstruction": { "Code": "0605" }, "LanguageOfInstruction": { "Code": "1201" }, "LocationOfInstruction": { "Code": "0340", "OtherCodeList": { "OtherCode": [ { "Codeset": "Text", "value": "NSW DEC" } ] } }, "SchoolCourseInfoOverride": { "Override": "Yes", "CourseCode": "CS101A", "StateCourseCode": "08-001A", "DistrictCourseCode": "CS101A", "SubjectArea": { "Code": "05", "OtherCodeList": { "OtherCode": [ { "Codeset": "Text", "value": "Graphic Arts for Beginners" } ] } }, "CourseTitle": "Graphics Basics", "InstructionalLevel": "Graduate Certificate II" } } }
<SectionInfo RefId="D3E34B35-9D75-101A-8C3D-00AA001A1652"> <SchoolCourseInfoRefId>101A8C3D-00AA-001A-0000-A2E35B359D75</SchoolCourseInfoRefId> <LocalId>287-1</LocalId> <SchoolYear>2013</SchoolYear> <MediumOfInstruction> <Code>0605</Code> </MediumOfInstruction> <LanguageOfInstruction> <Code>1201</Code> </LanguageOfInstruction> <LocationOfInstruction> <Code>0340</Code> <OtherCodeList> <OtherCode Codeset="Text">NSW DEC</OtherCode> </OtherCodeList> </LocationOfInstruction> <SchoolCourseInfoOverride Override="Yes"> <CourseCode>CS101A</CourseCode> <StateCourseCode>08-001A</StateCourseCode> <DistrictCourseCode>CS101A</DistrictCourseCode> <SubjectArea> <Code>05</Code> <OtherCodeList> <OtherCode Codeset="Text">Graphic Arts for Beginners</OtherCode> </OtherCodeList> </SubjectArea> <CourseTitle>Graphics Basics</CourseTitle> <InstructionalLevel>Graduate Certificate II</InstructionalLevel> </SchoolCourseInfoOverride> </SectionInfo>
Example 3.11.7-1: SectionInfo - Example 1

3.11.8 StudentSectionEnrollment

This object contains information about a student's enrollment in a section of a course.

SIF_Events are reported for this object.

StudentSectionEnrollment
Figure 3.11.8-1: StudentSectionEnrollment StudentSectionEnrollment RefId StudentPersonalRefId SectionInfoRefId SchoolYear EntryDate ExitDate LocalCodeList SIF_Metadata SIF_ExtendedElements
 Element/@AttributeCharPrivacy RatingDescriptionType
 StudentSectionEnrollment  

This object contains information about a student's enrollment in a section of a course.

 
 
@
key
RefIdM 

The Id (GUID) that uniquely identifies this StudentSectionEnrollment entity.

 
RefIdType
 StudentPersonalRefIdM 

The Id (GUID) of the student to whom the enrollment information applies.

 
IdRefType
 SectionInfoRefIdM 

The Id (GUID) of the section in which this student is enrolled.

 
IdRefType
 SchoolYearO 

School year for which the information is applicable, expressed as the four-digit year. e.g. 2013

 
SchoolYearType
 EntryDateO 

Date from when this course section enrollment is valid.

 
xs:date
 ExitDateO 

The last school calendar day (membership day) the student was enrolled in the course section (inclusive).

 
xs:date
 LocalCodeListOHigh LocalCodeListType
 SIF_MetadataOHigh SIF_MetadataType
 SIF_ExtendedElementsOHigh SIF_ExtendedElementsType
Table 3.11.8-1: StudentSectionEnrollment
{ "StudentSectionEnrollment": { "RefId": "983AC165-9879-3002-C3D0-0AA00456789D", "StudentPersonalRefId": "CAE29316-5987-101A-8C3D-00AA00456789", "SectionInfoRefId": "9076AB23-E386-112B-7EA2-256100BB3312", "SchoolYear": "2013", "EntryDate": "2013-02-02", "ExitDate": "2013-11-15" } }
<StudentSectionEnrollment RefId="983AC165-9879-3002-C3D0-0AA00456789D"> <StudentPersonalRefId>CAE29316-5987-101A-8C3D-00AA00456789</StudentPersonalRefId> <SectionInfoRefId>9076AB23-E386-112B-7EA2-256100BB3312</SectionInfoRefId> <SchoolYear>2013</SchoolYear> <EntryDate>2013-02-02</EntryDate> <ExitDate>2013-11-15</ExitDate> </StudentSectionEnrollment>
Example 3.11.8-1: StudentSectionEnrollment

3.11.9 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.

SIF_Events are reported for this object.

TeachingGroup
Figure 3.11.9-1: TeachingGroup TeachingGroup RefId SchoolYear LocalId ShortName LongName GroupType Set Block CurriculumLevel SchoolInfoRefId SchoolLocalId SchoolCourseInfoRefId SchoolCourseLocalId TimeTableSubjectRefId TimeTableSubjectLocalId KeyLearningArea Semester StudentList TeacherList MinClassSize MaxClassSize TeachingGroupPeriodList LocalCodeList SIF_Metadata SIF_ExtendedElements
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
@
key
RefIdMLow

The GUID of the TeachingGroup

 
RefIdType
 SchoolYearMLow

School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007").

 
SchoolYearType
 LocalIdMLow

LocalId of the Teaching Group (previously ClassIndicator).

 
LocalIdType
 ShortNameMLow

Short free format label that describes the group.

 
xs:normalizedString
 LongNameOLow

Longer description if required.

 
xs:normalizedString
 GroupTypeOLow

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
 SetOLow

Set Number (UK)

 
xs:normalizedString
 BlockOLow

Block (UK)

 
xs:normalizedString
 CurriculumLevelOLow

Assessment Stage eg VELS Level

 
xs:normalizedString
 SchoolInfoRefIdOLow

GUID of SchoolInfo object this teaching group belongs to.

 
RefIdType
 SchoolLocalIdOLow

Local School Id.

 
LocalIdType
 SchoolCourseInfoRefIdOLow

GUID of SchoolCourseInfo object this teaching group is part of.

 
RefIdType
 SchoolCourseLocalIdOLow

Local Course Id.

 
LocalIdType
 TimeTableSubjectRefIdOLow

GUID of TimeTableSubject object this teaching group belongs to.

 
RefIdType
 TimeTableSubjectLocalIdOLow

Local subject Id.

 
LocalIdType
 KeyLearningAreaOLow

Key Learning Area - map to ACStrand in Union with Religious Studies and Other.

 
AUCodeSetsACStrandType
 SemesterOLow

Semester, Term, or Quarter subject offered.

 
xs:unsignedInt
 StudentListOMedium

List of Students in this Teaching Group

 
StudentListType
 TeacherListOMedium

A List of teachers associated with the group - may or may not include the teacher timetabled in the schedule.

 
TeacherListType
 MinClassSizeOLow

Minimum class size.

 
xs:integer
 MaxClassSizeOLow

Maximum class size

 
xs:integer
 TeachingGroupPeriodListOLow

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
 LocalCodeListOMedium LocalCodeListType
 SIF_MetadataOMedium SIF_MetadataType
 SIF_ExtendedElementsOMedium SIF_ExtendedElementsType
Table 3.11.9-1: TeachingGroup
{ "TeachingGroup": { "RefId": "64A309DA-063A-2E35-B359-D75101A8C3D1", "SchoolYear": "2008", "LocalId": "20087ASPN", "ShortName": "7A SPN", "LongName": "Year 7A Maths - Space and Numbers", "Set": "4", "Block": "6", "CurriculumLevel": "VELS Level 5", "StudentList": { "TeachingGroupStudent": [ { "StudentPersonalRefId": "9897466F-200E-4BC1-B9AE-D1507DA15CEF", "StudentLocalId": "SMI001", "Name": { "Type": "LGL", "FamilyName": "Smith", "GivenName": "Peter" } }, { "StudentPersonalRefId": "7C834EA9-EDA1-2090-347F-83297E1C290D", "StudentLocalId": "SMI002", "Name": { "Type": "LGL", "FamilyName": "Smith", "GivenName": "Jennifer" } }, { "StudentPersonalRefId": "7C834EA9-EDA1-2090-347F-83297E1C290E", "StudentLocalId": "SMI003", "Name": { "Type": "LGL", "FamilyName": "Smith", "GivenName": "Terence" } } ] }, "TeacherList": { "TeachingGroupTeacher": [ { "StaffPersonalRefId": "A8C3A2E3-5B35-9D75-101D-00AA001A0000", "StaffLocalId": "SMI1", "Name": { "Type": "LGL", "FamilyName": "Smith", "GivenName": "Thomas" }, "Association": "Class Teacher" }, { "StaffPersonalRefId": "A8CCCCE3-5B35-9D75-101D-00AA001A0000", "StaffLocalId": "LONG2", "Name": { "Type": "LGL", "FamilyName": "Long", "GivenName": "Tamara" }, "Association": "Integration Aide" } ] }, "TeachingGroupPeriodList": { "TeachingGroupPeriod": [ { "DayId": "M", "PeriodId": "2" }, { "DayId": "F", "PeriodId": "6" } ] } } }
<TeachingGroup RefId="64A309DA-063A-2E35-B359-D75101A8C3D1"> <SchoolYear>2008</SchoolYear> <LocalId>20087ASPN</LocalId> <ShortName>7A SPN</ShortName> <LongName>Year 7A Maths - Space and Numbers</LongName> <Set>4</Set> <Block>6</Block> <CurriculumLevel>VELS Level 5</CurriculumLevel> <StudentList> <TeachingGroupStudent> <StudentPersonalRefId>9897466F-200E-4BC1-B9AE-D1507DA15CEF</StudentPersonalRefId> <StudentLocalId>SMI001</StudentLocalId> <Name Type="LGL"> <FamilyName>Smith</FamilyName> <GivenName>Peter</GivenName> </Name> </TeachingGroupStudent> <TeachingGroupStudent> <StudentPersonalRefId>7C834EA9-EDA1-2090-347F-83297E1C290D</StudentPersonalRefId> <StudentLocalId>SMI002</StudentLocalId> <Name Type="LGL"> <FamilyName>Smith</FamilyName> <GivenName>Jennifer</GivenName> </Name> </TeachingGroupStudent> <TeachingGroupStudent> <StudentPersonalRefId>7C834EA9-EDA1-2090-347F-83297E1C290E</StudentPersonalRefId> <StudentLocalId>SMI003</StudentLocalId> <Name Type="LGL"> <FamilyName>Smith</FamilyName> <GivenName>Terence</GivenName> </Name> </TeachingGroupStudent> </StudentList> <TeacherList> <TeachingGroupTeacher> <StaffPersonalRefId>A8C3A2E3-5B35-9D75-101D-00AA001A0000</StaffPersonalRefId> <StaffLocalId>SMI1</StaffLocalId> <Name Type="LGL"> <FamilyName>Smith</FamilyName> <GivenName>Thomas</GivenName> </Name> <Association>Class Teacher</Association> </TeachingGroupTeacher> <TeachingGroupTeacher> <StaffPersonalRefId>A8CCCCE3-5B35-9D75-101D-00AA001A0000</StaffPersonalRefId> <StaffLocalId>LONG2</StaffLocalId> <Name Type="LGL"> <FamilyName>Long</FamilyName> <GivenName>Tamara</GivenName> </Name> <Association>Integration Aide</Association> </TeachingGroupTeacher> </TeacherList> <TeachingGroupPeriodList> <TeachingGroupPeriod> <DayId>M</DayId> <PeriodId>2</PeriodId> </TeachingGroupPeriod> <TeachingGroupPeriod> <DayId>F</DayId> <PeriodId>6</PeriodId> </TeachingGroupPeriod> </TeachingGroupPeriodList> </TeachingGroup>
Example 3.11.9-1: TeachingGroup

3.11.10 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.

SIF_Events are reported for this object.

TimeTable
Figure 3.11.10-1: TimeTable TimeTable RefId SchoolInfoRefId SchoolYear LocalId Title DaysPerCycle PeriodsPerDay TeachingPeriodsPerDay SchoolLocalId SchoolName TimeTableCreationDate StartDate EndDate TimeTableDayList LocalCodeList SIF_Metadata SIF_ExtendedElements
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
@
key
RefIdMLow

GUID that identifies this TimeTable object.

 
RefIdType
 SchoolInfoRefIdOLow

Optional, the GUID of the SchoolInfo Object if this object is known in the zone.

 
IdRefType
 SchoolYearMLow

School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007").

 
SchoolYearType
 LocalIdOLow

Local TimeTable ID

 
LocalIdType
 TitleMLow

Unique Name of the proposed Time Table

 
xs:normalizedString
 DaysPerCycleMLow

Max Number of days per Time Table cycle

 
xs:unsignedInt
 PeriodsPerDayMLow

Max Number of periods per Time Table Day

 
xs:unsignedInt
 TeachingPeriodsPerDayOLow

Teaching periods per day if different to PeriodsPerDay

 
xs:unsignedInt
 SchoolLocalIdOLow

Optional Local School Id

 
LocalIdType
 SchoolNameOLow

The school name in plain text.

 
xs:normalizedString
 TimeTableCreationDateOLow

Date Schedule was created or last edited.

 
xs:date
 StartDateOLow

First day of TimeTable.

 
xs:date
 EndDateOLow

Last day of the TimeTable.

 
xs:date
 TimeTableDayListMLow

Container for TimeTableDays in Schedule

 
TimeTableDayListType
 LocalCodeListOLow LocalCodeListType
 SIF_MetadataOLow SIF_MetadataType
 SIF_ExtendedElementsOLow SIF_ExtendedElementsType
Table 3.11.10-1: TimeTable
{ "TimeTable": { "RefId": "64A309DA-063A-2E35-B359-D75101A8C3D0", "SchoolInfoRefId": "F2256EE2-B67F-47D6-AB47-94D4DEE0D0AD", "SchoolYear": "2008", "LocalId": "2008S1", "Title": "2008 Semester 1", "DaysPerCycle": 5, "PeriodsPerDay": 6, "TeachingPeriodsPerDay": 5, "SchoolLocalId": "01011234", "SchoolName": "Newest Secondary College", "TimeTableCreationDate": "2008-02-01", "StartDate": "2008-01-30", "EndDate": "2008-06-20", "TimeTableDayList": { "TimeTableDay": [ { "DayId": "1", "DayTitle": "Monday", "TimeTablePeriodList": { "TimeTablePeriod": [ { "PeriodId": "1", "PeriodTitle": "P1" }, { "PeriodId": "2", "PeriodTitle": "P2" }, { "PeriodId": "3", "PeriodTitle": "P3" }, { "PeriodId": "4", "PeriodTitle": "P4" }, { "PeriodId": "5", "PeriodTitle": "P5" }, { "PeriodId": "6", "PeriodTitle": "P6" } ] } }, { "DayId": "2", "DayTitle": "Tuesday", "TimeTablePeriodList": { "TimeTablePeriod": [ { "PeriodId": "1", "PeriodTitle": "P1" }, { "PeriodId": "2", "PeriodTitle": "P2" }, { "PeriodId": "3", "PeriodTitle": "P3" }, { "PeriodId": "4", "PeriodTitle": "P4" }, { "PeriodId": "5", "PeriodTitle": "P5" }, { "PeriodId": "6", "PeriodTitle": "P6" } ] } } ] } } }
<TimeTable RefId="64A309DA-063A-2E35-B359-D75101A8C3D0"> <SchoolInfoRefId>F2256EE2-B67F-47D6-AB47-94D4DEE0D0AD</SchoolInfoRefId> <SchoolYear>2008</SchoolYear> <LocalId>2008S1</LocalId> <Title>2008 Semester 1</Title> <DaysPerCycle>5</DaysPerCycle> <PeriodsPerDay>6</PeriodsPerDay> <TeachingPeriodsPerDay>5</TeachingPeriodsPerDay> <SchoolLocalId>01011234</SchoolLocalId> <SchoolName>Newest Secondary College</SchoolName> <TimeTableCreationDate>2008-02-01</TimeTableCreationDate> <StartDate>2008-01-30</StartDate> <EndDate>2008-06-20</EndDate> <TimeTableDayList> <TimeTableDay> <DayId>1</DayId> <DayTitle>Monday</DayTitle> <TimeTablePeriodList> <TimeTablePeriod> <PeriodId>1</PeriodId> <PeriodTitle>P1</PeriodTitle> </TimeTablePeriod> <TimeTablePeriod> <PeriodId>2</PeriodId> <PeriodTitle>P2</PeriodTitle> </TimeTablePeriod> <TimeTablePeriod> <PeriodId>3</PeriodId> <PeriodTitle>P3</PeriodTitle> </TimeTablePeriod> <TimeTablePeriod> <PeriodId>4</PeriodId> <PeriodTitle>P4</PeriodTitle> </TimeTablePeriod> <TimeTablePeriod> <PeriodId>5</PeriodId> <PeriodTitle>P5</PeriodTitle> </TimeTablePeriod> <TimeTablePeriod> <PeriodId>6</PeriodId> <PeriodTitle>P6</PeriodTitle> </TimeTablePeriod> </TimeTablePeriodList> </TimeTableDay> <TimeTableDay> <DayId>2</DayId> <DayTitle>Tuesday</DayTitle> <TimeTablePeriodList> <TimeTablePeriod> <PeriodId>1</PeriodId> <PeriodTitle>P1</PeriodTitle> </TimeTablePeriod> <TimeTablePeriod> <PeriodId>2</PeriodId> <PeriodTitle>P2</PeriodTitle> </TimeTablePeriod> <TimeTablePeriod> <PeriodId>3</PeriodId> <PeriodTitle>P3</PeriodTitle> </TimeTablePeriod> <TimeTablePeriod> <PeriodId>4</PeriodId> <PeriodTitle>P4</PeriodTitle> </TimeTablePeriod> <TimeTablePeriod> <PeriodId>5</PeriodId> <PeriodTitle>P5</PeriodTitle> </TimeTablePeriod> <TimeTablePeriod> <PeriodId>6</PeriodId> <PeriodTitle>P6</PeriodTitle> </TimeTablePeriod> </TimeTablePeriodList> </TimeTableDay> </TimeTableDayList> </TimeTable>
Example 3.11.10-1: TimeTable

3.11.11 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.

SIF_Events are reported for this object.

TimeTableCell
Figure 3.11.11-1: TimeTableCell TimeTableCell RefId TimeTableRefId TimeTableSubjectRefId TeachingGroupRefId RoomInfoRefId StaffPersonalRefId TimeTableLocalId SubjectLocalId TeachingGroupLocalId RoomNumber StaffLocalId DayId PeriodId CellType SchoolInfoRefId SchoolLocalId TeacherList RoomList LocalCodeList SIF_Metadata SIF_ExtendedElements
 Element/@AttributeCharPrivacy RatingDescriptionType
 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:

  • the timetable it belongs to,
  • the subject that is being scheduled,
  • the teaching group (representing the students, teachers and subject),
  • the room that is allocated,
  • the allocated teacher.

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.

 
 
@
key
RefIdMLow

The GUID of the TimeTableCell

 
RefIdType
 TimeTableRefIdMLow

The GUID of the TimeTable to which this Cell belongs

 
IdRefType
 TimeTableSubjectRefIdOLow

The GUID of the Subject that this Cell is scheduling

 
IdRefType
 TeachingGroupRefIdMLow

The GUID of the TeachingGroup being scheduled

 
IdRefType
 RoomInfoRefIdOLow

The GUID of the Resource being Scheduled

 
IdRefType
 StaffPersonalRefIdOLow

The GUID of the Staff Member being Scheduled

 
IdRefType
 TimeTableLocalIdOLow

Time Table Local Identifier

 
LocalIdType
 SubjectLocalIdOLow

Subject Local Id

 
LocalIdType
 TeachingGroupLocalIdOLow

Teaching Group

 
LocalIdType
 RoomNumberOLow

Room number as presented to the user/application.

 
HomeroomNumberType
 StaffLocalIdOLow

Staff LocalId

 
LocalIdType
 DayIdMLow

Day Id

 
LocalIdType
 PeriodIdMLow

Period Id within the Day Id

 
LocalIdType
 CellTypeMLow

Type of Lesson/Session eg Teaching, Lunch etc

 
xs:normalizedString
 SchoolInfoRefIdOLow

Optional, the GUID of the SchoolInfo Object if this object is known in the zone

 
IdRefType
 SchoolLocalIdOLow

Optional, Local School Id

 
LocalIdType
 TeacherListOLow

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
 RoomListOLow

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
 LocalCodeListOHigh LocalCodeListType
 SIF_MetadataOLow SIF_MetadataType
 SIF_ExtendedElementsOLow SIF_ExtendedElementsType
Table 3.11.11-1: TimeTableCell
{ "TimeTableCell": { "RefId": "64A309DA-063A-2E35-B359-D75101A8C3D1", "TimeTableRefId": "64A309DA-063A-2E35-B359-D75101A8C3D0", "TimeTableSubjectRefId": "22860091-7192-45B4-AB0C-F5B9DC19DE5C", "TeachingGroupRefId": "64A309DA-063A-2E35-B359-D75101A8C3D1", "RoomInfoRefId": "D3E34B35-9D75-101A-8C3D-00AA001A1652", "StaffPersonalRefId": "D3E34F41-9D75-101A-8C3D-00AA001A1652", "TimeTableLocalId": "2008S1", "SubjectLocalId": "07AR", "TeachingGroupLocalId": "20087ASPN 2008S1", "RoomNumber": "101", "StaffLocalId": "946379881", "DayId": "1", "PeriodId": "1", "CellType": "T", "SchoolInfoRefId": "D3E34B35-9D75-101A-8C3D-00AA001A1652", "SchoolLocalId": "01011234", "TeacherList": { "TeacherCover": [ { "StaffPersonalRefId": "98157AA0-13BA-8C3D-00AA-012B359D7512", "StaffLocalId": "US8923", "StartTime": "12:05:00", "FinishTime": "13:00:00", "Credit": "In-Lieu", "Supervision": "MinimalSupervision", "Weighting": 0.5 }, { "StaffPersonalRefId": "A75A0010-1A8C-301D-02E3-A05B359D0A00", "StaffLocalId": "ZY3213", "StartTime": "13:00:00", "FinishTime": "13:30:00", "Credit": "Extra", "Supervision": "MinimalSupervision", "Weighting": 0.5 } ] }, "RoomList": { "RoomInfoRefId": [ "11737EA4-301C-ADCA-75C8-7214A7C46BDB" ] } } }
<TimeTableCell RefId="64A309DA-063A-2E35-B359-D75101A8C3D1"> <TimeTableRefId>64A309DA-063A-2E35-B359-D75101A8C3D0</TimeTableRefId> <TimeTableSubjectRefId>22860091-7192-45B4-AB0C-F5B9DC19DE5C</TimeTableSubjectRefId> <TeachingGroupRefId>64A309DA-063A-2E35-B359-D75101A8C3D1</TeachingGroupRefId> <RoomInfoRefId>D3E34B35-9D75-101A-8C3D-00AA001A1652</RoomInfoRefId> <StaffPersonalRefId>D3E34F41-9D75-101A-8C3D-00AA001A1652</StaffPersonalRefId> <TimeTableLocalId>2008S1</TimeTableLocalId> <SubjectLocalId>07AR</SubjectLocalId> <TeachingGroupLocalId>20087ASPN 2008S1</TeachingGroupLocalId> <RoomNumber>101</RoomNumber> <StaffLocalId>946379881</StaffLocalId> <DayId>1</DayId> <PeriodId>1</PeriodId> <CellType>T</CellType> <SchoolInfoRefId>D3E34B35-9D75-101A-8C3D-00AA001A1652</SchoolInfoRefId> <SchoolLocalId>01011234</SchoolLocalId> <TeacherList> <TeacherCover> <StaffPersonalRefId>98157AA0-13BA-8C3D-00AA-012B359D7512</StaffPersonalRefId> <StaffLocalId>US8923</StaffLocalId> <StartTime>12:05:00</StartTime> <FinishTime>13:00:00</FinishTime> <Credit>In-Lieu</Credit> <Supervision>MinimalSupervision</Supervision> <Weighting>0.5</Weighting> </TeacherCover> <TeacherCover> <StaffPersonalRefId>A75A0010-1A8C-301D-02E3-A05B359D0A00</StaffPersonalRefId> <StaffLocalId>ZY3213</StaffLocalId> <StartTime>13:00:00</StartTime> <FinishTime>13:30:00</FinishTime> <Credit>Extra</Credit> <Supervision>MinimalSupervision</Supervision> <Weighting>0.5</Weighting> </TeacherCover> </TeacherList> <RoomList> <RoomInfoRefId>11737EA4-301C-ADCA-75C8-7214A7C46BDB</RoomInfoRefId> </RoomList> </TimeTableCell>
Example 3.11.11-1: TimeTableCell

3.11.12 TimeTableContainer

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.

TimeTableContainer
Figure 3.11.12-1: TimeTableContainer TimeTableContainer RefId TimeTableSchedule TimeTableScheduleCellList TeachingGroupScheduleList LocalCodeList SIF_Metadata SIF_ExtendedElements
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
@
key
RefIdMLow

GUID that identifies this TimeTable Container.

 
RefIdType
 TimeTableScheduleOLow TimeTableScheduleType
 TimeTableScheduleCellListOLowAll the TimeTable Cells that belong to this TimeTable. TimeTableScheduleCellListType
 TeachingGroupScheduleListOLowAll the Teaching Groups that belong to this TimeTable. TeachingGroupScheduleType
 LocalCodeListOLow LocalCodeListType
 SIF_MetadataOLow SIF_MetadataType
 SIF_ExtendedElementsOLow SIF_ExtendedElementsType
Table 3.11.12-1: TimeTableContainer

3.11.13 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.

SIF_Events are reported for this object.

TimeTableSubject
Figure 3.11.13-1: TimeTableSubject TimeTableSubject RefId SubjectLocalId AcademicYear AcademicYearRange CourseLocalId SchoolCourseInfoRefId Faculty SubjectShortName SubjectLongName SubjectType ProposedMaxClassSize ProposedMinClassSize SchoolInfoRefId SchoolLocalId Semester SchoolYear OtherCodeList LocalCodeList SIF_Metadata SIF_ExtendedElements
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
@
key
RefIdMLow

GUID that identifies this TimeTableSubject.

 
RefIdType
 SubjectLocalIdMLow

SubjectLocalID - Distinct piece of curriculum that is to be scheduled.

 
LocalIdType
 AcademicYearCLow

Subject Year Level. Either AcademicYear or AcademicYearRange must be provided.

 
YearLevelType
 AcademicYearRangeCLow

Range of Academic Years subject spans. Either AcademicYear or AcademicYearRange must be provided.

 
YearRangeType
 CourseLocalIdOLow

Local Course Id, if associated with a Course.

 
LocalIdType
 SchoolCourseInfoRefIdOLow

The GUID of the SchoolCourseInfo object.

 
RefIdType
 FacultyOLow

Faculty

 
xs:normalizedString
 SubjectShortNameOLow

SubjectShortName

 
xs:normalizedString
 SubjectLongNameMLow

SubjectLongName

 
xs:normalizedString
 SubjectTypeOLow

Core or Elective or ?

 
xs:normalizedString
 ProposedMaxClassSizeOLow

Suggested maximum class size for this subject.

 
xs:decimal
 ProposedMinClassSizeOLow

Suggested minimum class size for this subject.

 
xs:decimal
 SchoolInfoRefIdOLow

Optional the GUID of the SchoolInfo Object if this object is known in the zone.

 
IdRefType
 SchoolLocalIdOLow

Optional Local School Id

 
LocalIdType
 SemesterOLow

Semester, Term, or Quarter subject offered.

 
xs:unsignedInt
 SchoolYearOLow

School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007").

 
SchoolYearType
 OtherCodeListOLowAny other codes this subject is known by; eg VASS code for VCE in Vic. OtherCodeListType
 LocalCodeListOHigh LocalCodeListType
 SIF_MetadataOLow SIF_MetadataType
 SIF_ExtendedElementsOLow SIF_ExtendedElementsType
Table 3.11.13-1: TimeTableSubject
{ "TimeTableSubject": { "RefId": "D3E34B35-9D75-101A-8C3D-00AA001A1652", "SubjectLocalId": "07AR", "AcademicYear": { "Code": "7" }, "SubjectShortName": "7 ART", "SubjectLongName": "Year 7 Art", "SubjectType": "E", "SchoolYear": "2009" } }
<TimeTableSubject RefId="D3E34B35-9D75-101A-8C3D-00AA001A1652"> <SubjectLocalId>07AR</SubjectLocalId> <AcademicYear> <Code>7</Code> </AcademicYear> <SubjectShortName>7 ART</SubjectShortName> <SubjectLongName>Year 7 Art</SubjectLongName> <SubjectType>E</SubjectType> <SchoolYear>2009</SchoolYear> </TimeTableSubject>
Example 3.11.13-1: TimeTableSubject

Valid XHTML 1.0 Transitional