The introduction for the SIF AU data model.
The work assigned to students, an educational event planned by a teacher to deliver a particular educational concept or skill.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
Activity | The work assigned to students, an educational event planned by a teacher to deliver a particular educational concept or skill. | |||
@ | RefId | M | RefIdType | |
Title | O | Descriptive name of the activity. | xs:normalizedString | |
Preamble | O | Description and context for the activity. | xs:string | |
TechnicalRequirements | O | List of Operating system, network, and other technical requirements for the activity, if applicable. | TechnicalRequirementsType | |
SoftwareRequirementList | O | Contains information about required software. | SoftwareRequirementListType | |
EssentialMaterials | O | Essential materials required to engage in this activity. | EssentialMaterialsType | |
LearningObjectives | O | Educational objectives of the activity. | LearningObjectivesType | |
LearningStandards | O | Associated | LearningStandardsType | |
SubjectArea | O | SubjectAreaType | ||
Prerequisites | O | Skills or competencies the student must have to engage in activity. | PrerequisitesType | |
Students | O | Links to any students or group or category of students that this activity is for. | StudentsType | |
SourceObjects | O | Source objects assigned to students. | SourceObjectsType | |
Points | O | Number of possible points for an activity. | xs:unsignedInt | |
ActivityTime | M | Time structures for the activity. | ActivityTimeType | |
AssessmentRefId | O | Link to the SIF Assessment object containing the evaluation information for this activity. | IdRefType | |
MaxAttemptsAllowed | O | How many tries allowed. | xs:unsignedInt | |
ActivityWeight | O | The percentage weight of the activity during the particular course or term. | xs:decimal | |
Evaluation | O | Field for non-numeric types of grading and evaluation such as "narrative." | ||
@ | EvaluationType | M | A qualifer for what type of evaluation this is. Valid values are "Inline" and "RefId". Inline values are contained in the optional Description element, RefIds are contained in the AssessmentRefId element. | values:
|
Evaluation/Description | O | A free text description of the evaluation to be used for this activity | xs:string | |
LearningResources | O | Learning resources that support this activity. | LearningResourcesType | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object defines the attribute of a group of objects that implicitly or explicitly defines a subset of the group for statistical purposes.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
AggregateCharacteristicInfo | This object defines the attribute of a group of objects that implicitly or explicitly defines a subset of the group for statistical purposes. | |||
@ | RefId | M | Key for aggregate characteristic information. | RefIdType |
Description | O |
Describes the supercategory of the characteristic described in the Examples | xs:string | |
Definition | M | Defines the aggregate characteristic information. Examples | xs:token | |
ElementName | O |
Reference to SIF elements or external authority (e.g., Examples | xs:token | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object is the actual value of a statistical measurement. It is always associated with one statistic and one or more characteristics.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
AggregateStatisticFact | This object is the actual value of a statistical measurement. It is always associated with one statistic and one or more characteristics. | |||
@ | RefId | M | RefIdType | |
AggregateStatisticInfoRefId | M |
Reference to statistic defined by AggregateStatisticInfo .
| IdRefType | |
Characteristics | M |
Reference to one or more | CharacteristicsType | |
Excluded | O | values:
| ||
Value | M | Value of the fact. | xs:decimal | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object defines the data that is being aggregated as well as the type of measurement that is being performed.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
AggregateStatisticInfo | This object defines the data that is being aggregated as well as the type of measurement that is being performed. | |||
@ | RefId | M | Key | RefIdType |
StatisticName | M | Name of Aggregate Statistic Examples | xs:token | |
CalculationRule | O | Rule for calculating the aggregate statistic | xs:string | |
@ | Type | M | values:
| |
ApprovalDate | O | Date for which the statistic is initially valid | xs:date | |
ExpirationDate | O | Date after which the statistic is no longer valid | xs:date | |
ExclusionRules | O | Rules for which statistic may not be reported. | ExclusionRulesType | |
Source | O | System providing the data: i.e., SIS, Transportation, | xs:token | |
EffectiveDate | O | Effective date of the statistic | xs:date | |
DiscontinueDate | O | Discontinue date of the statistic | xs:date | |
Location | O | Location where the activity takes place. | LocationType | |
Measure | O | Type of the statistic. | values:
| |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object defines information related to a school calendar day in a given school calendar year. If both CalendarDate and CalendarSummary objects are supported, there must be an instance of this object for each date between CalendarSummary StartDate and EndDate, inclusive.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
CalendarDate | This object defines information related to a school calendar day in a given school calendar year. If both CalendarDate and CalendarSummary objects are supported, there must be an instance of this object for each date between CalendarSummary StartDate and EndDate, inclusive. | |||
@ | CalendarDateRefId | M | An ID (GUID) for this day date of the calendar information that is being reported. This GUID would be used to form a REST URL. | IdRefType |
Date | M | A specific school day that occurs within the school year. | xs:date | |
CalendarSummaryRefId | M | The ID (GUID) of the calendar summary in which this calendar date is. | IdRefType | |
SchoolInfoRefId | M | The ID (GUID) of the school for which this calendar information is being reported. | IdRefType | |
SchoolYear | M | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2009"). | SchoolYearType | |
CalendarDateType | M | Calendar date type information. | CalendarDateInfoType | |
CalendarDateNumber | O | Order in which the calendar date falls within the school calendar. | xs:unsignedInt | |
StudentAttendance | O | Information describing how the day relates to student attendance. | AttendanceInfoType | |
TeacherAttendance | O | Information describing how the day relates to teacher attendance. | AttendanceInfoType | |
AdministratorAttendance | O | Information describing how the day relates to administrator attendance. | AttendanceInfoType | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object provides a summary of a school's calendar information for a given school year. A school may have more than one calendar per school year (e.g., one calendar for Kindergarten students, one for special education students, one for seniors, or one for each calendar track), and each may have different days in session, start and end dates, minutes per day, instructional minutes, etc.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
CalendarSummary | This object provides a summary of a school's calendar information for a given school year. A school may have more than one calendar per school year (e.g., one calendar for Kindergarten students, one for special education students, one for seniors, or one for each calendar track), and each may have different days in session, start and end dates, minutes per day, instructional minutes, etc. | |||
@ | RefId | M | The ID (GUID) of the calendar to which this information relates. | RefIdType |
SchoolInfoRefId | M | The ID (GUID) of the school for which this calendar information is being reported. | IdRefType | |
SchoolYear | M | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007"). | SchoolYearType | |
LocalId | M | The locally assigned identifier for this calendar. | LocalIdType | |
Description | O | Textual description of the school calendar. | xs:string | |
DaysInSession | M | The total number of days that the school was or is anticipated to be in session during the school year. Also included are days on which the education institution facility is closed and the student body as a whole is engaged in planned activities off-campus under the guidance and direction of staff members. | xs:unsignedInt | |
StartDate | O | The first calendar date, whether or not instruction was provided. If both CalendarSummary and CalendarDate objects are supported, StartDate must be the date of the first chronological instance of CalendarDate for the school's calendar. | xs:date | |
EndDate | O | The last calendar date, whether or not instruction was provided. If both CalendarSummary and CalendarDate objects are supported, EndDate must be the last chronological instance of CalendarDate for the school's calendar. | xs:date | |
FirstInstructionDate | O | The first day of student instruction. | xs:date | |
LastInstructionDate | O | The last day of student instruction (including days or times that students are present for purposes of testing and/or evaluation, but not including whole or part-days whose sole purposes is for distribution of report cards). | xs:date | |
GraduationDate | O | Date of graduation ceremony. | GraduationDateType | |
InstructionalMinutes | O | The total number of instructional minutes for this calendar for the school year. | xs:unsignedInt | |
MinutesPerDay | O | The number of minutes in the day in which the school is normally in session. | xs:unsignedInt | |
YearLevels | O | Collection of year levels applicable to this school calendar. | YearLevelsType | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
ChargedLocationInfo represents a location in a school system. It can be used to associate accounts and purchase orders with particular schools or other cost centres.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
ChargedLocationInfo | ChargedLocationInfo represents a location in a school system. It can be used to associate accounts and purchase orders with particular schools or other cost centres. | |||
@ | RefId | M | The SIF unique identifier for the location. | RefIdType |
LocationType | M | Defines whether the location is a school or a non-school location. | values:
| |
SiteCategory | M | Specific site category. Examples | xs:normalizedString | |
Name | M | Text name of the location. | xs:normalizedString | |
Description | O | Description about the location. | xs:normalizedString | |
LocalId | O | The locally-assigned identifier for this location. | LocalIdType | |
StateProvinceId | O | The state-assigned identifier for this location. | StateProvinceIdType | |
ParentChargedLocationInfoRefId | O | A ChargedLocationInfo instance could be related to another ChargedLocationInfo. This element will help create that relation. | IdRefType | |
SchoolInfoRefId | O | The RefId of a corresponding SchoolInfo object. | IdRefType | |
AddressList | O | This element has the ChargedLocationInfo address information. | AddressListType | |
PhoneNumberList | O | The location's phone numbers. | PhoneNumberListType | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object is used to capture general information about debtors.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
Debtor | This object is used to capture general information about debtors. | |||
@ | RefId | M | Debtor Id. | RefIdType |
BilledEntity | M | Id of the entity referred to by this object (e.g., student, employee, organization). | IdRefType | |
@ | SIF_RefObject | M | SIF object referenced by BilledEntity. | values:
|
AddressList | O | Addresses of the debtor to be used for billing. These addresses override any addresses found in the Billed Entity. | AddressList | |
BillingName | O | Name of the entity to be used for billing (e.g. company name rather than individual name). | xs:normalizedString | |
BillingNote | O | Note about billing requirements. | xs:normalizedString | |
Discount | O | Any discount amount applicable to this debtor (e.g. family discount for scholarship, number of children enrolled). Is a percentage. | xs:normalizedString | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
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 | Description | Type | |
---|---|---|---|---|
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. | |||
@ | RefId | M | The GUID of the Object | RefIdType |
Name | M | Name of the equipment. | xs:normalizedString | |
Description | O | Description of the equipment. | xs:normalizedString | |
LocalId | M | The Local Id of the equipment. | LocalIdType | |
AssetNumber | O | Asset number of the equipment; may be distinct from Local Id. | LocalIdType | |
InvoiceRefId | O | The SIF RefId of the invoice for the equipment. | IdRefType | |
PurchaseOrderRefId | O | The SIF RefId of the purchase order for the equipment. | IdRefType | |
EquipmentType | O | Type of equipment. | union of: AUCodeSetsEquipmentTypeType xs:token | |
SIF_RefId | O | The SIF RefId of the owner/location of the equipment. | IdRefType | |
@ | SIF_RefObject | M | The type of SIF object that the SIF_RefId element identifies. | values:
|
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object communicates information about a financial account.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
FinancialAccount | This object communicates information about a financial account. | |||
@ | RefId | M | GUID that identifies this financial account. | RefIdType |
ParentAccountRefId | O | Identifier of a parent account of the account. Can be used to construct a hierarchical tree of nesting accounts, e.g. "Revenue" -- "Revenue-Grant" -- "Revenue-Grant-Commonwealth". | IdRefType | |
ChargedLocationInfoRefId | O | Location associated with the account". | IdRefType | |
AccountNumber | M | Account number used for ledger. | xs:normalizedString | |
Name | M | Name of the account. | xs:normalizedString | |
Description | O | Description of the account. | xs:normalizedString | |
ClassType | M | The class of the account | values:
| |
CreationDate | M | Account creation date. | xs:date | |
CreationTime | M | Account creation time. | xs:time | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object provides information about a particular assignment, allows applications to synchronize each other's assignment tables, gathers the definition for a GradingAssignmentScore object, etc.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
GradingAssignment | This object provides information about a particular assignment, allows applications to synchronize each other's assignment tables, gathers the definition for a GradingAssignmentScore object, etc. | |||
@ | RefId | M | A GUID that identifies an instance of this object. | RefIdType |
TeachingGroupRefId | O | The GUID for the TeachingGroup object in which this assignment has been set. | IdRefType | |
SchoolInfoRefId | O | The Id (GUID) that uniquely identifies the School in which this assignment has been set. | IdRefType | |
GradingCategory | O | A particular grading category for the assignment, used to provide grouping and type information. | xs:normalizedString | |
Description | M | The text-based description of the assignment. | xs:normalizedString | |
PointsPossible | M | The points possible on the assignment. | xs:unsignedInt | |
CreateDate | O | Creation date of the assignment. | xs:date | |
DueDate | O | Date the assignment is due. | xs:date | |
Weight | O | The weight of the assignment. | xs:decimal | |
MaxAttemptsAllowed | O | How many attempts the student is allowed on the assignment (applicable particularly to online activities). | xs:integer | |
DetailedDescriptionURL | O | The location of the document that describes the assignment. If Type is PDF, this element will contain the Base64 encoding of the entire document. Preferred against DetailedDescriptionBinary for online assessment. | xs:anyURI | |
DetailedDescriptionBinary | O | The Base64 encoding of a document (e.g. PDF) describing the assignment. | xs:base64Binary | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object provides score information about a particular assignment.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
GradingAssignmentScore | This object provides score information about a particular assignment. | |||
@ | RefId | M | A GUID that identifies an instance of this object. | RefIdType |
StudentPersonalRefId | O | The GUID for the student whose score this is. | IdRefType | |
StudentPersonalLocalId | M | The Local Id for the student whose score this is. | LocalIdType | |
TeachingGroupRefId | O | The GUID for the TeachingGroup object in which this assignment has been set. | IdRefType | |
SchoolInfoRefId | O | The Id (GUID) that uniquely identifies the School in which this assignment has been set. | IdRefType | |
GradingAssignmentRefId | M | The grading assignment for which this is a score. | IdRefType | |
ScorePoints | C | The score represented as points. Conditionally required that one or more of ScorePoints, ScorePercent or ScoreLetter must be filled in. For online assignments, ScorePoints should be used to the exclusion of other scores. | xs:unsignedInt | |
ScorePercent | C | The score represented as a percent. Conditionally required that one or more of ScorePoints, ScorePercent or ScoreLetter must be filled in. | xs:decimal | |
ScoreLetter | C | The score represented as a letter grade. Conditionally required that one or more of ScorePoints, ScorePercent or ScoreLetter must be filled in. | xs:token | |
ScoreDescription | O | Text description of the score. | xs:normalizedString | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object allows a system that stores network identities and/or passwords to share them with other applications through SIF. The provider of the Identity
object may only support providing an identity or a password, or it may support both.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
Identity |
This object allows a system that stores network identities and/or passwords to share them with other applications through SIF. The provider of the | |||
@ | RefId | M | The SIF RefId that uniquely identifies this object. | RefIdType |
SIF_RefId | M | The SIF RefId of a StudentPersonal, StaffPersonal, or StudentContactPersonal object. | IdRefType | |
@ | SIF_RefObject | M |
The type of SIF object that the | values:
|
AuthenticationSource | M |
The type of source system that produced this See implementation notes for provider requirements. | values:
| |
IdentityAssertions | O | The list of identity assertions for this user. | IdentityAssertionsType | |
PasswordList | O | Allows a provider or publisher to specify the same password using multiple algorithms, if supported. | PasswordListType | |
AuthenticationSourceGlobalUID | O | The globally unique person identifier that links together separate Identity objects which reference the same Person. | IdRefType | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object contains an amount to be invoiced to an outside entity (typically a creditor or debtor). This object can include school fees. The object is also used for payments to an outside entity (using debit amounts), where those payments are not for goods and services (PurchaseOrder object): e.g. credit notes, reimbursements, rebates.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
Invoice | This object contains an amount to be invoiced to an outside entity (typically a creditor or debtor). This object can include school fees. The object is also used for payments to an outside entity (using debit amounts), where those payments are not for goods and services (PurchaseOrder object): e.g. credit notes, reimbursements, rebates. | |||
@ | RefId | M | GUID for this transaction. The application that owns this object is responsible for generating this unique Id. | RefIdType |
InvoicedEntity | M | Id of the entity being billed for this billing activity. | IdRefType | |
@ | SIF_RefObject | M | RefId of SIF object referenced by Invoiced Entity. | values:
|
FormNumber | O | Invoice number assigned locally by the system issuing the invoice. | LocalIdType | |
BillingDate | M | Date of the transaction. | xs:date | |
TransactionDescription | M | Description of the transaction. | xs:normalizedString | |
BilledAmount | M | Gross amount to be billed, including any tax. Can be credit (e.g. for family credit notes, reimbursements, rebates). | DebitOrCreditAmountType | |
Ledger | M | The associated ledger for this transaction | values:
| |
ChargedLocationInfoRefId | O | Id of the location billed for this billing activity. | IdRefType | |
NetAmount | O | Net amount billed, excluding any tax. Should be BilledAmount minus TaxAmount. | MonetaryAmountType | |
TaxRate | O | Rate of tax included in the billed amount. | xs:decimal | |
TaxType | O | Tax type (e.g. G11 vs NP6) | xs:normalizedString | |
TaxAmount | O | Amount of tax included in the billed amount | MonetaryAmountType | |
CreatedBy | O | Authority or person who created the invoice | xs:normalizedString | |
ApprovedBy | O | Authority or person who approved the invoice | xs:normalizedString | |
ItemDetail | O | Details of items invoiced (free text) | xs:normalizedString | |
DueDate | O | Due date for payment. | xs:date | |
FinancialAccountRefIdList | O | Suggested minimum class size for this subject. | FinancialAccountRefIdListType | |
AccountingPeriod | O | The accounting period against which the transaction is billed. | LocalIdType | |
RelatedPurchaseOrderRefId | O | An invoice purchase order related to this invoice (e.g. an invoice raised for the delivery of goods on a purchase order). | IdRefType | |
PurchasingItems | O | Listing of line items from original purchase order. Included to indicate any variation between the items, item cost, or item quantity ordered, and what has been delivered. | PurchasingItemsType | |
Voluntary | O | Whether the billing is voluntary (applies to some school fees). | AUCodeSetsYesOrNoCategoryType | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object is used to adjust balances between accounts. It is typically used to correct chart of account coding errors (e.g. created invoices for parents against the maths chart of account code when it should have been English).
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
Journal | This object is used to adjust balances between accounts. It is typically used to correct chart of account coding errors (e.g. created invoices for parents against the maths chart of account code when it should have been English). | |||
@ | RefId | M | Journal Id. | RefIdType |
DebitFinancialAccountRefId | M | RefId of account to debit. | IdRefType | |
CreditFinancialAccountRefId | M | RefId of account to credit. | IdRefType | |
OriginatingTransactionRefId | O | RefId of the originating transaction which requires adjustment. This could be an Invoice, PaymentReceipt or PurchaseOrder. | IdRefType | |
@ | SIF_RefObject | M | values:
| |
Amount | M | Amount to transfer between the two accounts. | MonetaryAmountType | |
GSTCodeOriginal | O | Original GST code for journal transfer (if required). | xs:normalizedString | |
GSTCodeReplacement | O | Replacement GST code for journal transfer (if required). | xs:normalizedString | |
Note | O | Note about the journal. | xs:normalizedString | |
CreatedDate | O | Date on which journal was created. | xs:date | |
ApprovedDate | O | Date on which journal was approved. | xs:date | |
CreatedBy | O | Authority or person who created the journal. | xs:normalizedString | |
ApprovedBy | O | Authority or person who approved the journal. | xs:normalizedString | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object contains information about a school district, region, or other Local, State or Jurisdiction Educational Authority.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
LEAInfo | This object contains information about a school district, region, or other Local, State or Jurisdiction Educational Authority. | |||
@ | RefId | M | The GUID of the LEA whose information this is. | RefIdType |
LocalId | M | The locally-assigned identifier for this LEA. | LocalIdType | |
StateProvinceId | O | The state-assigned identifier for this LEA. | StateProvinceIdType | |
CommonwealthId | O | Commonwealth Identifier for this Entity. | xs:normalizedString | |
LEAName | M | Name of LEA. | xs:normalizedString | |
LEAURL | O | URL for the LEA. | xs:anyURI | |
EducationAgencyType | O | The classification of the education agency within the geographic boundaries of a state according to the level of administrative and operational control. | AgencyType | |
LEAContactList | O | LEAContactListType | ||
PhoneNumberList | O | The LEA's phone number(s). | PhoneNumberListType | |
AddressList | O | The LEA's address(es). | AddressListType | |
OperationalStatus | O | Operational condition of a school. | OperationalStatusType | |
JurisdictionLowerHouse | O | Lower House area that the school/campus belongs to. | xs:normalizedString | |
SLA | O | Statistical Local Area that the school/campus belongs to. | AUCodeSetsAustralianStandardGeographicalClassificationASGCType | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object contains information related to learning resources that may be used in educational settings. These include textbooks, Internet content, educational software, videos and DVDs, supplemental print material, etc.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
LearningResource | This object contains information related to learning resources that may be used in educational settings. These include textbooks, Internet content, educational software, videos and DVDs, supplemental print material, etc. | |||
@ | RefId | M | GUID assigned to this LearningResource. | RefIdType |
Name | M | Name of learning resource. | xs:normalizedString | |
Author | O | Name of organization or company that created the resource. | xs:normalizedString | |
Contacts | O | Contains contact information about resource authors. | ContactsType | |
Location | O | Description of location of resource, i.e. location in library or URL, community resource, outside resource supplier. | xs:string | |
@ | ReferenceType | M | A qualifying attribute for the Location payload. If ReferenceType is "URI", the payload contains a web address where the resource can be found. | xs:token |
Status | O | Describes availability status of resource, e.g. "checked out." | xs:normalizedString | |
Description | O | Description of the resource, e.g., "This textbook is intended for year 4 social studies students and addresses..." | xs:string | |
YearLevels | O | YearLevelsType | ||
SubjectAreas | O | ACStrandAreaListType | ||
MediaTypes | O | Resource media types. | MediaTypesType | |
UseAgreement | O | Describes terms of use for resource. | xs:string | |
AgreementDate | O | A date that defines the date of agreement. | xs:date | |
Approvals | O | Authorizations to use this resource. For example, this resource may be included as part of the district's standard curriculum model. | ApprovalsType | |
Evaluations | O | Evaluations/review of the resource. | EvaluationsType | |
Components | M | Lesson or activity-sized portions of a resource. | ComponentsType | |
LearningStandards | O | References to LearningStandardItems. | LearningStandardsType | |
LearningResourcePackageRefId | O |
Reference to a | IdRefType | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
Many instructional applications in a SIF zone need to share teaching and learning objects.
Curriculum planning applications, content repositories, learning management systems, etc.—all of these systems need to share
instructional content utilizing the LearningResource
object.
The LearningResourcePackage
object provides a transport envelope to move these files across the SIF zone.
Note: With SIF Implementation Specification version 2.4 the choice element depicted in the diagram below has changed. In the XSD files, the choice element used to be rendered as a sequence of optional elements. Now, in the XSD files, the choice element is rendered as an xs:choice. This may cause problems with agents that treat the choice element as two optional elements rather than a choice of one and only one of the choices.
SIF_Events are not reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
LearningResourcePackage | A wrapper for any external learning content to be transmitted across a SIF Zone. | AbstractContentPackageType |
A curriculum standards document or the like published by a national, state, district, school site, professional association or other interested party. The LearningStandardDocument reflects an expectation of student work.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
LearningStandardDocument | A curriculum standards document or the like published by a national, state, district, school site, professional association or other interested party. The LearningStandardDocument reflects an expectation of student work. | |||
@ | RefId | M | Id for the standards document | RefIdType |
Title | M | Name of curriculum document, i.e., "NSW History Curriculum K-10." | xs:normalizedString | |
Description | O | Description of the standards document. | xs:string | |
RichDescription | O | Description of the curriculum document that allows pictures as well as text.. | AbstractContentElementType | |
Source | M |
Defines source of standard document. This is the descriptive type of the organization listed in | values:
| |
Organizations | M | OrganizationsType | ||
Authors | O | AuthorsType | ||
OrganizationContactPoint | O | A brief description of how to contact the organization maintaining the standards. It could be a phone number, email address, or URL. | xs:string | |
SubjectAreas | M | ACStrandAreaListType | ||
DocumentStatus | M | values:
| ||
DocumentDate | O | The date the current status was achieved. | xs:date | |
LocalAdoptionDate | O | The date the local organization adopted this standard document | xs:date | |
LocalArchiveDate | O | The date the local organization stopped using this standard document and superseded by a new document. | xs:date | |
EndOfLifeDate | O | This is the date that the governing organization retired this document. | xs:date | |
Copyright | O | Copyright for document. | ||
Copyright/Date | C | Copyright date | xs:date | |
Copyright/Holder | C | Name of the copyright holder | xs:normalizedString | |
YearLevels | O | SIF common YearLevels element | YearLevelsType | |
RepositoryDate | O | Date document data was added to the repository | xs:date | |
LearningStandardItemRefId | M | Link to the first/top LearningStandardItem in the standard hierarchy | IdRefType | |
RelatedLearningStandards | O | LearningStandardsDocumentType | ||
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
LearningStandardItem | This object contains information related to curriculum standards statements "standards" or "benchmarks" or the like within the document. Each LearningStandardItem reflects an individual standard statement and may occur at several levels within a hierarchially structured document. | |||
@ | RefId | M | GUID assigned to each statement at each level within the document hierarchy | RefIdType |
Resources | O | Container for related resources. | LResourcesType | |
StandardSettingBody | O | The name of the state or organization that authored and manages updates to the curriculum document (i.e., ACARA, NSW DET). | ||
StandardSettingBody/Country | M | CountryType | ||
StandardSettingBody/StateProvince | O | StateProvinceType | ||
StandardSettingBody/SettingBodyName | O | This is the text version of the organization's name. | xs:normalizedString | |
StandardHierarchyLevel | M | Description of hierarchical level within standards tree. | ||
StandardHierarchyLevel/Number | M | Integer assigned to each hierarchical level within standards tree. The top level is "1". | xs:unsignedInt | |
StandardHierarchyLevel/Description | M | Used to describe what role this item is serving in the structure. Some documents describe their levels in terms of standard, strands, and topics. Others use standards, benchmarks, and indicators. In Australia, this is typically in terms of Course or Unit, Year Level, Outcomes. This attribute names the level of the item. | xs:string | |
PredecessorItems | O | GUID assigned to the LearningStandardItem directly above it in the hierarchy tree. This is a repeatable element because a single granular item may relate to multiple parent levels of the hierarchy. If the object has no parent, the ParentRefId should be the same as the object's RefId. The RefId in LearningStandardDocumentRefId will always point to the parent's LearningStandardDocument object. | LearningStandardsType | |
StatementCodes | O | StatementCodesType | ||
Statements | O | StatementsType | ||
YearLevels | M | YearLevelsType | ||
ACStrandSubjectArea | O | ACStrandSubjectAreaType | ||
StandardIdentifier | O | This element describes the unique identifier for each LearningStandard. | ||
StandardIdentifier/YearCreated | M | This represents the year that this specific learning standard was created. This is important to indicate as standards are updated to reflect the appropriate year it was created. This would be assigned by and unique to the standard setting body. | xs:gYear | |
StandardIdentifier/ACStrandSubjectArea | M | This represents the subject or content area this curriculum item addresses. This would be assigned by and unique to the curriculum setting body. | ACStrandSubjectAreaType | |
StandardIdentifier/StandardNumber | M | This is the specific number of the standard. For example, if the subject is mathematics and this standard is Patterns, Functions and Algebra, this would be StandardNumber 1. This would be assigned by and unique to the standard setting body. | xs:normalizedString | |
StandardIdentifier/YearLevels | M | This represents the grade level(s) this specific learning standard will address. This may be addressed in different ways. Some states have a grade level that covers several grades and others have just one grade. This would be assigned by and unique to the standard setting body. | YearLevelsType | |
StandardIdentifier/Benchmark | O | This is the next level within the hierarchy of the learning standard. For example, if the subject is mathematics and the standard is algebra, this would be the next delineation - Represent an unknown quantity as a variable using a symbol, including letters. This would be assigned by and unique to the standard setting body. | xs:normalizedString | |
StandardIdentifier/YearLevel | O | This is the specific year level. This is to be utilized if the YearLevel covers several years. This would be assigned by and unique to the standard setting body. | YearLevelType | |
StandardIdentifier/IndicatorNumber | O | This would be the most granular level of the learning standard associated with the grade level. Following the same example, an indicator for Algebra YearLevel 5-7, the indicator for the benchmark above at Year 6 would be to Evaluate simple expressions by replacing variables with given values, and use formulas in problem-solving situations. This would be assigned by and unique to the standard setting body. | xs:normalizedString | |
StandardIdentifier/AlternateIdentificationCodes | O | This element is for an organization to utilize for an internal code. This may be used for an alignment schema or other purposes that are only internal for the organization. | List | |
StandardIdentifier/AlternateIdentificationCodes/ AlternateIdentificationCode | MR | An alphanumeric Id code as defined by the organization to identify the statement. | xs:normalizedString | |
StandardIdentifier/Organization | M | Name of organization represented by the document, i.e., "National Council of Teachers of Mathematics (NCTM)," "NSW," "ACARA." This is the name of the organization that has this AlternateIdentificationCode. This should be a text field. | xs:normalizedString | |
LearningStandardDocumentRefId | M | The RefId of the item's parent LearningStandardDocument. | IdRefType | |
RelatedLearningStandardItems | O | Container for external relationships. | List | |
RelatedLearningStandardItems/ LearningStandardItemRefId | OR | A relationship between the current standard item and another standard item. | IdRefType | |
@ | RelationshipType | M | Type of the relationship between the current standard and the target standard. The value identifies the type of standard of the target item. The purpose of this information is to allow applications to sort/display these relationships in the appropriate context. | union of: AUCodeSetsLearningStandardItemRelationshipTypesType xs:token |
Level4 | O | This is the second to most granular level of the learning or performance standard associated with the grade level. | xs:normalizedString | |
Level5 | O | This is the most granular level of the learning or performance standard associated with the grade level. | xs:normalizedString | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object complements the Invoice object, and contains information about the payment of a Invoice object.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
PaymentReceipt | This object complements the Invoice object, and contains information about the payment of a Invoice object. | |||
@ | RefId | M | GUID for this payment or receipt. The application that owns this object is responsible for generating this unique Id. | RefIdType |
TransactionType | M | Type of transaction. | values:
| |
InvoiceRefId | O | A pointer back to the Invoice object corresponding to this payment. Is omitted for general ledger transactions, creditor receipts and debtor payments. | IdRefType | |
VendorInfoRefId | O | A pointer back to the vendor associated with the Invoice object, if applicable. | IdRefType | |
DebtorRefId | O | A pointer back to the debtor associated with the Invoice object, if applicable. | IdRefType | |
ChargedLocationInfoRefId | O | Id of the location billed for this transaction. | IdRefType | |
TransactionDate | M | Date transaction was made. | xs:date | |
TransactionAmount | M | Amount received. | DebitOrCreditAmountType | |
ReceivedTransactionId | M | Memo transaction Id from other vendor software. | xs:normalizedString | |
FinancialAccountRefIdList | O | FinancialAccountRefIdListType | ||
TransactionDescription | O | Description of the transaction. | xs:normalizedString | |
TaxRate | O | Rate of tax included in the billed amount. | xs:decimal | |
TaxAmount | O | Amount of tax included in the billed amount. | MonetaryAmountType | |
TransactionMethod | O | Method through which transaction was made (e.g. cash, credit card). If a receipt is made using two receipt methods (e.g. $20 in cash and $80 on credit), two PaymentReceipt objects are expected to be created, rather than a single object with mixed receipt method. | xs:normalizedString | |
ChequeNumber | O | The cheque number issued, if paying creditors by cheque. | xs:normalizedString | |
TransactionNote | O | Note about the receipt or payment. | xs:normalizedString | |
AccountingPeriod | O | The accounting period against which the transaction is billed. | LocalIdType | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object contains information about the person's picture.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
PersonPicture | This object contains information about the person's picture. | |||
@ | RefId | M | The ID (GUID) that uniquely identifies the picture. | RefIdType |
ParentObjectRefId | M | The GUID of the personal object to which this picture is linked | IdRefType | |
@ | SIF_RefObject | M | The name of the object reference. | values:
|
SchoolYear | M |
School year for which this enrollment is applicable, expressed as the four-digit year in which the school year
ends (e.g. | SchoolYearType | |
PictureSource | M | This element defines the picture. If the Type attribute is URL, this is the location of the picture in [JPEG] format; if Type is JPEG, this is the [JPEG] image data encoded using the Base64 Content-Transfer-Encoding defined in Section 6.8 of [RFC 2045]. | URIOrBinaryType | |
@ | Type | M | The way the picture is specified. | AUCodeSetsPictureSourceType |
OKToPublish | O | Can the picture be published? | AUCodeSetsYesOrNoCategoryType | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object provides information down to the line item level for purchase orders.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
PurchaseOrder | This object provides information down to the line item level for purchase orders. | |||
@ | RefId | M | Transaction GUID for this purchasing activity. The application that owns this object and is responsible for generating this unique Id. | RefIdType |
FormNumber | M | Purchase order number. | xs:normalizedString | |
VendorInfoRefId | M | This object references the VendorInfo object being billed. | IdRefType | |
ChargedLocationInfoRefId | O | The location Id for this purchasing activity. | IdRefType | |
EmployeePersonalRefId | O | The employee Id for the originator of this purchasing activity. | IdRefType | |
PurchasingItems | M | PurchasingItemsType | ||
CreationDate | O | Date on which purchase order was created. | xs:date | |
TaxRate | O | Rate of tax included in the billed amount. | xs:decimal | |
TaxAmount | O | Amount of tax included in the billed amount. | MonetaryAmountType | |
TotalAmount | O | Total amount billed. | MonetaryAmountType | |
UpdateDate | O | Date on which the object was last updated. | xs:date | |
FullyDelivered | O | Flag that order has been fully delivered. | AUCodeSetsYesOrNoCategoryType | |
OriginalPurchaseOrderRefId | O | Original purchase order that this purchase order updates (e.g. to cancel line items). | IdRefType | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | 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 | Description | Type | |
---|---|---|---|---|
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. | |||
@ | RefId | M | The GUID of the Object | RefIdType |
ResourceRefId | O | 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 | The type of SIF object that the ResourceRefId element identifies. | values:
|
ResourceLocalId | M | The Local Id of the resource being booked. Provided whether the resource is a SIF object or not. | LocalIdType | |
StartDateTime | M | Starting date and time for booking. | xs:dateTime | |
FinishDateTime | M | Finish date and time for booking. | xs:dateTime | |
FromPeriod | O | Starting period for booking. If specified, the booking is intended to align with bell times. | LocalIdType | |
ToPeriod | O | Finish period for booking. If specified, the booking is intended to align with bell times. | LocalIdType | |
Booker | M | 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 | A free-text explanation of the reason for the room booking. | xs:normalizedString | |
ScheduledActivityRefId | O | Links the room-booking to a ScheduledActivity. | IdRefType | |
KeepOld | O | 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 | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object tracks resource usage by a student or staff member at a school over a defined time period.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
ResourceUsage | This object tracks resource usage by a student or staff member at a school over a defined time period. | |||
@ | RefId | M | The SIF RefId that uniquely identifies this object. | RefIdType |
SchoolInfoRefId | M | SIF RefId that identifies the school providing the resource being tracked. | IdRefType | |
ResourceUsageContentType | M | Information about the ResourceUsage. | ||
ResourceUsageContentType/ Code | M | Codeset for type of resource being tracked. | AUCodeSetsResourceUsageContentTypeType | |
ResourceUsageContentType/ LocalDescription | O | Local description of type of resource being tracked. | xs:string | |
ResourceReportColumnList | M | Definitions of the values given in ResourceReportList/ ResourceReport/ ReportRow. | List | |
ResourceReportColumnList/ ResourceReportColumn | MR | Definition of a single value given in ResourceReportList/ ResourceReport/ ReportRow; the value definitions in ReportColumnList appear in the same order as they do in ReportRow. | ||
ResourceReportColumnList/ ResourceReportColumn/ColumnName | M | Name of a ReportRow value. | xs:normalizedString | |
ResourceReportColumnList/ ResourceReportColumn/ColumnDescription | O | Description of a ReportRow value. | xs:normalizedString | |
ResourceReportColumnList/ ResourceReportColumn/ColumnDelimiter | O | Delimiter separating this ReportRow value from the next; is assumed by default to be ",", with CSV parsing rules. | xs:normalizedString | |
ResourceReportLineList | M | List of resource reports, one per user. | List | |
ResourceReportLineList/ResourceReportLine | MR | List of resource reports, one per user. | ||
ResourceReportLineList/ResourceReportLine/ SIF_RefId | O | SIF RefId that identifies the student, staff or group whose usage is being tracked. | IdRefType | |
@ | SIF_RefObject | M |
The type of SIF object that the | values:
|
ResourceReportLineList/ResourceReportLine/ StartDate | M | Starting date for reporting period of resource usage. | xs:date | |
ResourceReportLineList/ResourceReportLine/ EndDate | O | End date for reporting period of resource usage. | xs:date | |
ResourceReportLineList/ResourceReportLine/ CurrentCost | M | Current cost of reported resource usage. | MonetaryAmountType | |
ResourceReportLineList/ResourceReportLine/ ReportRow | M | Key of report-specific values, defined in ReportColumn | xs:normalizedString | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | 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 | Description | Type | |
---|---|---|---|---|
RoomInfo | This object contains all of the information about a school's room. This object may contain a reference to a room type so that it may represent anything from a gym, cafeteria, to a standard classroom. The StaffList element usually contains the homeroom teacher. | |||
@ | RefId | M | GUID that identifies this room. | RefIdType |
SchoolInfoRefId | M | GUID that identifies the school that this room belongs to. | IdRefType | |
LocalId | O | The locally assigned identifier for the room. | LocalIdType | |
RoomNumber | M | 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 | StaffListType | ||
Description | O |
Friendly name that can be assigned to the room (e.g. | xs:normalizedString | |
Building | O | Extra building information. In the future Building could become its own object in which case this element will need to be changed to a RefId. Currently it is only required as a free text field. | xs:normalizedString | |
HomeroomNumber | O | When a room is designated as a homeroom it may have a different number. Usually blank when room is not a homeroom. | xs:normalizedString | |
Size | O | Size in square meters. | xs:decimal | |
Capacity | O | Number of persons (usually students) that this room can hold. | xs:unsignedInt | |
PhoneNumber | O | Phone number for the room | PhoneNumberType | |
RoomType | O | Type of room, for use in timetabling. | xs:token | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | 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 | Description | Type | |
---|---|---|---|---|
ScheduledActivity | This object provides a broader range of scheduled activities than just normal teaching classes (as covered by SessionInfo). | |||
@ | RefId | M | The GUID of the Object | RefIdType |
SchoolInfoRefId | M | The ID (GUID) of the school for which this attendance information is being reported. | IdRefType | |
TimeTableCellRefId | O | 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 | Day Id. | LocalIdType | |
PeriodId | O | Period Id within the Day Id | LocalIdType | |
TimeTableRefId | O | The GUID of the TimeTable to which this Cell belongs | IdRefType | |
ActivityDate | M | 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 | 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 | 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 | Type of Lesson/Session eg Teaching, Lunch etc. | xs:normalizedString | |
TimeTableSubjectRefId | O | Optional to link the GUID of the Subject, if this is a piece of curriculum being scheduled. | IdRefType | |
TeacherList | O | 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 | 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 | The address(es) associated with the scheduled activity. | AddressListType | |
Location | O | 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 | The type of activity undertaken. | AUCodeSetsScheduledActivityTypeType | |
ActivityName | O | 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 | 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 | 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 | 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 | List of year levels offered by the school. | YearLevelsType | |
Override | O | 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 | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | 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 | Description | Type | |
---|---|---|---|---|
SchoolCourseInfo | This object is for course information. All local ids in non-authoritative objects are optional. It is therefore up to the provider and the actual agent's design and choreography to determine whether or not to use or local ids from parent objects. There are cases in some subscribing systems where it might not possible to add RefId columns and therefore the RefId of related objects cannot be stored. For example a target system that listens to TimeTableSubject events and updates them may not be able to store the associated SchoolCourseInfoRefId with that object. The only way it can link the TimeTableSubject object with the appropriate course might be through its local course id. Having local ids that link the parent objects with the child object can simplify the agent design. Generally it is suggested to use the appropriate RefIds whenever possible and only use local ids if there is no other way to use RefIds. | |||
@ | RefId | M | The ID (GUID) that uniquely identifies the school course. | RefIdType |
SchoolInfoRefId | M | The ID (GUID) that identifies the school where the course is offered. | IdRefType | |
SchoolLocalId | O | The locally-assigned identifier for this school/campus. | LocalIdType | |
SchoolYear | C |
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 | The ID (GUID) that uniquely identifies this TermInfo (reportable time period). Either SchoolYear or TermInfoRefId must be provided. | IdRefType | |
CourseCode | M | School-defined local code for the course. | xs:normalizedString | |
StateCourseCode | O | State-defined standard course code used to report information about courses. | xs:normalizedString | |
DistrictCourseCode | O | The corresponding district course code. | xs:normalizedString | |
SubjectAreaList | O | Subject matter areas. | SubjectAreaListType | |
CourseTitle | M | Title of the course. | xs:normalizedString | |
Description | O | Textual description of the course. | xs:normalizedString | |
InstructionalLevel | O | An indication of the general nature and difficulty of instruction provided. | xs:normalizedString | |
CourseCredits | O | The number of credits awarded upon course completion. | xs:normalizedString | |
CoreAcademicCourse | O | Does the course meet the state definition of a core academic course? | AUCodeSetsYesOrNoCategoryType | |
GraduationRequirement | O | Does the state require that the course be completed for graduation? | AUCodeSetsYesOrNoCategoryType | |
Department | O | Department with jurisdiction over this course. | xs:normalizedString | |
CourseContent | O | Description of course content. | xs:normalizedString | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object contains information about the school or campus.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SchoolInfo | This object contains information about the school or campus. | |||
@ | RefId | M | The GUID that identifies this school. | RefIdType |
LocalId | O | The locally-assigned identifier for this school. | LocalIdType | |
StateProvinceId | O | The state-assigned identifier for this school. | StateProvinceIdType | |
CommonwealthId | O | Commonwealth identifier for this school/campus. | xs:normalizedString | |
ACARAId | O | ACARA identifier for this school/campus. | xs:normalizedString | |
OtherIdList | O | Lists all "other" identifiers associated with the school. | OtherIdListType | |
SchoolName | M | Name of school/campus. | xs:normalizedString | |
LEAInfoRefId | O | The ID (GUID) that references the school district of which this school is a member. | RefIdType | |
OtherLEA | O | The ID (GUID) of another related education agency, such as a regional service agency. | RefIdType | |
@ | SIF_RefObject | M | The name of the object reference. | values:
|
SchoolDistrict | O | The school district of which this school/campus is a member. Equivalent to DEECD Region. | xs:normalizedString | |
SchoolDistrictLocalId | O | The school district Local ID. This should be the same as the LocalId in the LEAInfo if LEAInfo details are supplied. | LocalIdType | |
SchoolType | O | An indication of the level of the educational institution. | AUCodeSetsSchoolLevelType | |
SchoolFocusList | O | Lists all "other" identifiers associated with the student. | SchoolFocusListType | |
SchoolURL | O | URL for the school. | SchoolURLType | |
SchoolEmailList | O | List of contact emails for the school. | EmailListType | |
PrincipalInfo | O | Information about the campus or school principal. | PrincipalInfoType | |
SchoolContactList | O | A list of contact persons associated with a school. | SchoolContactListType | |
AddressList | O | The school's addresses. | AddressListType | |
PhoneNumberList | O | The school's phone numbers. | PhoneNumberListType | |
SessionType | O | Code that specifies the session type. | AUCodeSetsSessionTypeType | |
YearLevels | O | List of year levels offered by the school. | YearLevelsType | |
ARIA | O | Accessibility/Remoteness Indicator of Australia. | xs:decimal | |
OperationalStatus | O | Operational condition of a school. | OperationalStatusType | |
FederalElectorate | O | Australian Federal Electorate. | AUCodeSetsFederalElectorateType | |
Campus | O | Optional campus details. | CampusContainerType | |
SchoolSector | M | (Government, or Non-Government). | AUCodeSetsSchoolSectorCodeType | |
IndependentSchool | O | Indicator as to whether school is an independent school (as opposed to government or catholic school). | AUCodeSetsYesOrNoCategoryType | |
NonGovSystemicStatus | O | Used to clarify a non-government school's systemic status. Either Systemic or Non-Systemic. | AUCodeSetsSystemicStatusType | |
System | O | System if a systemic school. | AUCodeSetsSchoolSystemType | |
ReligiousAffiliation | O | Religious affiliation (if any). | AUCodeSetsAustralianStandardClassificationOfReligiousGroupsASCRGType | |
SchoolGeographicLocation | O | School Location from MCEETCYA. | AUCodeSetsSchoolLocationType | |
LocalGovernmentArea | O | LocalGovernmentArea that that school/campus is located in. | xs:normalizedString | |
JurisdictionLowerHouse | O | Lower House area that the school/campus belongs to. | xs:normalizedString | |
SLA | O | Statistical Local Area that the school/campus belongs to. | AUCodeSetsAustralianStandardGeographicalClassificationASGCType | |
SchoolCoEdStatus | O | Gender of student population. | AUCodeSetsSchoolCoEdStatusType | |
BoardingSchoolStatus | O | Is this school a Boarding School? | AUCodeSetsYesOrNoCategoryType | |
YearLevelEnrollmentList | O | Container for number of students enrolled per year level. | YearLevelEnrollmentListType | |
TotalEnrollments | O | Optional School/Campus enrolments. | TotalEnrollmentsType | |
Entity_Open | O | Opening date of entity. | xs:date | |
Entity_Close | O | Closing date of entity. This element is allowed to be omitted and/or null. | xs:date | |
SchoolGroupList | O | SchoolGroupListType | ||
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SchoolPrograms | This object contains information about Programs offered by a school. | |||
@ | RefId | M | GUID that uniquely identifies this instance of the object. | RefIdType |
SchoolInfoRefId | M | GUID that identifies the school offering this program. | IdRefType | |
SchoolYear | O | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2009"). | SchoolYearType | |
SchoolProgramList | O | List of School Programs | SchoolProgramListType | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | 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 | Description | Type | |
---|---|---|---|---|
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; | |||
@ | RefId | M | The Id (GUID) that uniquely identifies this section entity. | RefIdType |
SchoolCourseInfoRefId | M | The Id (GUID) that identifies the course being taught in this section. | IdRefType | |
LocalId | M | The locally-assigned identifier for this course section. | LocalIdType | |
Description | O | Description of the course section. | xs:normalizedString | |
SchoolYear | C |
School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g. | SchoolYear | |
TermInfoRefId | C | The Id (GUID) of the term to which this schedule information relates. Either TermInfoRefId or SchoolYear must be provided. | IdRefType | |
MediumOfInstruction | O | Medium through which the student receives instructional communication from the teacher. | MediumOfInstructionType | |
LanguageOfInstruction | O | Language in which the section is taught. | LanguageOfInstructionType | |
LocationOfInstruction | O | Description of the location in which the section is taught. | LocationOfInstructionType | |
SummerSchool | O | Is this a summer school assignment? | values:
| |
SchoolCourseInfoOverride | O | Optional overrides of the course information for this section. | SchoolCourseInfoOverrideType | |
CourseSectionCode | O | 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 | 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 | Indicates if attendance in this section is collected and used in attendance calculations. | values:
| |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object provides the link between Period Attendance and the school's timetable. It allows subject and teaching group information to be communicated to/from the attendance system.
This object provides information about the session; the specific instance of a timetable cell against which the attendance is recorded. Please note, the TimeTableCell object represents a session scheduled in a timetable. There may be many SessionInfo objects for the same TimeTableCell each for a different week/fortnight, depending on the length of the timetable schedule. Attendance is recorded against the SessionInfo object.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SessionInfo | This object provides the link between Period Attendance and the school's timetable. It allows subject and teaching group information to be communicated to/from the attendance system. This object provides information about the session; the specific instance of a timetable cell against which the attendance is recorded. Please note, the TimeTableCell object represents a session scheduled in a timetable. There may be many SessionInfo objects for the same TimeTableCell each for a different week/fortnight, depending on the length of the timetable schedule. Attendance is recorded against the SessionInfo object. | |||
@ | RefId | M | The GUID of the Object | RefIdType |
SchoolInfoRefId | M | The ID (GUID) of the school for which this attendance information is being reported. | IdRefType | |
TimeTableCellRefId | M | The (GUID) of the piece of Curriculum (TT Grid) scheduled | IdRefType | |
SchoolYear | M | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007"). | SchoolYearType | |
LocalId | M | Session Local Identifier | LocalIdType | |
TimeTableSubjectLocalId | M | TimeTableSubject Local Identifier | LocalIdType | |
TeachingGroupLocalId | M | Teaching Group Local Identifier | LocalIdType | |
SchoolLocalId | O | School Local Identifier | LocalIdType | |
StaffPersonalLocalId | O | Staff Local Identifier | LocalIdType | |
RoomNumber | C | Room number as presented to the user or application. Needs to be provided if changed from TimeTableCell. | xs:normalizedString | |
DayId | M | Day Id. | LocalIdType | |
PeriodId | M | Period Id within the Day Id | LocalIdType | |
SessionDate | M | Date of Session | xs:date | |
StartTime | O | Optional Start Time | xs:time | |
FinishTime | O | Optional End Time | xs:time | |
RollMarked | O | Was the Roll Marked for this Period? | AUCodeSetsYesOrNoCategoryType | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object defines information related to a staff member's assignment(s); commonly, this will be a school assignment.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||||||
---|---|---|---|---|---|---|---|---|---|---|
StaffAssignment | This object defines information related to a staff member's assignment(s); commonly, this will be a school assignment. | |||||||||
@ | RefId | M | The GUID that uniquely identifies a particular staff assignment. | RefIdType | ||||||
SchoolInfoRefId | M | The ID (GUID) that identifies the school where the staff member is assigned. | IdRefType | |||||||
SchoolYear | O |
School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., | SchoolYearType | |||||||
StaffPersonalRefId | M | ID (GUID) of this staff member, as represented in the StaffPersonal object. | IdRefType | |||||||
Description | O | Short assignment description | xs:normalizedString | |||||||
PrimaryAssignment | M |
Is this the staff member's primary assignment? Note: There must be one and only one instance of the object with a | AUCodeSetsYesOrNoCategoryType | |||||||
JobStartDate | O | This is the date from which the staff assignment is valid (inclusive). | xs:date | |||||||
JobEndDate | O | This is the date through which the staff assignment is valid (inclusive). | xs:date | |||||||
JobFTE | O | Full-time job equivalent ratio for this assignment. (Format is x.xx; an employee who is full-time and who is 50% of their time on this assignment would be represented as 0.50) | xs:decimal
| |||||||
JobFunction | O | The purpose of the activities as related to students. | xs:string | |||||||
EmploymentStatus | O | Status of staff member within this school. Where a Staff member is employed by an organisation that covers more than one school, employment status may be different at each school. Not for NSSC Reporting | AUCodeSetsStaffStatusType | |||||||
StaffSubjectList | O | Subject(s) Staff member is eligible to teach. | StaffSubjectListType | |||||||
StaffActivity | O | The purpose of the Teacher's role as related to students. Equivalent to 'JobFunction' in US Object. | StaffActivityExtensionType | |||||||
YearLevels | O | Year level(s) that the teacher is allowed to teach. | YearLevelsType | |||||||
CasualReliefTeacher | O | Is this teacher a casual relief teacher CRT? | AUCodeSetsYesOrNoCategoryType | |||||||
Homegroup | O | The name of the homegroup the staff member is assigned to. | xs:normalizedString | |||||||
House | O | The name of the house the staff member is assigned to. | xs:normalizedString | |||||||
CalendarSummaryList | O | The ID (GUID) of a calendar summary to which this Staff Member is associated with. | CalendarSummaryListType | |||||||
SIF_Metadata | O | SIF_MetadataType | ||||||||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object contains all the personal information relating to a staff member, who might be a teacher or other employee of the school or district.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
StaffPersonal | This object contains all the personal information relating to a staff member, who might be a teacher or other employee of the school or district. | |||
@ | RefId | M | The GUID of the staff member. | RefIdType |
LocalId | M | The locally-assigned identifier for this staff member. | LocalIdType | |
StateProvinceId | O | The state-assigned identifier for this staff member. | StateProvinceIdType | |
ElectronicIdList | O | Electronic identifier(s) associated with this entity. | ElectronicIdListType | |
OtherIdList | O | Lists all "other" identifiers associated with the staff member. | OtherIdListType | |
PersonInfo | M | Personal Information | PersonInfoType | |
Title | O | The staff member's title. | xs:normalizedString | |
EmploymentStatus | O | Status of staff member within employing organisation. Not for NSSC Reporting | AUCodeSetsStaffStatusType | |
MostRecent | O | Container for elements reflecting the most recent assignment of a staff member. If the staff member is currently assigned, the elements contain current information. | StaffMostRecentContainerType | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
Co-curricular or extra-curricular activities (e.g., student organizations, inter-school sports, athletics, publications, band, orchestra, and service activities) in which students may participate.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
StudentActivityInfo | Co-curricular or extra-curricular activities (e.g., student organizations, inter-school sports, athletics, publications, band, orchestra, and service activities) in which students may participate. | |||
@ | RefId | M | The ID (GUID) that uniquely identifies the instance of the object. | RefIdType |
Title | M | Name of the co-curricular or extra-curricular activity. | xs:normalizedString | |
Description | O | The description of the co-curricular or extra-curricular activity. | xs:normalizedString | |
StudentActivityType | M | Information regarding the co-curricular or extra-curricular activity. | StudentActivityType | |
StudentActivityLevel | O | A description of the separation of level in the activity (e.g. House, Inter-school, Club, State, National). | xs:normalizedString | |
YearLevels | O | Collection of year levels applicable to this co-curricular or extra-curricular activity. | YearLevelsType | |
CurricularStatus | O | An indication of the degree to which an activity is related to a student's curriculum. | AUCodeSetsActivityTypeType | |
Location | O | Location where the activity takes place. | LocationType | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
StudentActivityParticipation | This object provides information on a co-curricular or extra-curricular activity in which a student participates during a given school year. | |||
@ | RefId | M | The ID (GUID) that uniquely identifies the instance of the object. | RefIdType |
StudentPersonalRefId | M | GUID that identifies the student participating in the activity. | IdRefType | |
StudentActivityInfoRefId | M | GUID that identifies the activity in which the student participates. | IdRefType | |
SchoolYear | O | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2009"). | SchoolYearType | |
ParticipationComment | O | Comment related to the student's participation in the activity. | xs:string | |
StartDate | O | This is the date from which the activity participation is valid (inclusive). | xs:date | |
EndDate | O | This is the date through which the activity participation is valid (inclusive). If element is supported by the publisher/responder, should contain a date if the student withdraws from the activity before the end of the school year. | xs:date | |
Role | O | Specific role the student plays in the activity (e.g., band leader, student body president). | xs:normalizedString | |
RecognitionList | O | List of awards and other types of recognition given to the student for this activity. | RecognitionListType | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object provides a summary of a student's daily attendance and membership information for a given school during the time period between the StartDate and EndDate, inclusive. As such, there may be multiple instances of this object for a student in a school over the course of a school year.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||||||
---|---|---|---|---|---|---|---|---|---|---|
StudentAttendanceSummary | This object provides a summary of a student's daily attendance and membership information for a given school during the time period between the StartDate and EndDate, inclusive. As such, there may be multiple instances of this object for a student in a school over the course of a school year. | |||||||||
@ | StudentAttendanceSummaryRefId | O | An ID (GUID) for this summary of attendance information being reported on. This GUID would be used to form a REST URL. | IdRefType | ||||||
StudentPersonalRefId | M | The ID (GUID) of the student for whom this attendance information is being reported. | IdRefType | |||||||
SchoolInfoRefId | M | The ID (GUID) of the school for which this attendance information is being reported. | IdRefType | |||||||
SchoolYear | M | School year for which the information is applicable. | SchoolYearType | |||||||
StartDate | M | Starting date of this attendance reporting period. | xs:date | |||||||
EndDate | M | Ending date of this attendance reporting period. | xs:date | |||||||
StartDay | O | Number of the school day represented in StartDate. | xs:unsignedInt | |||||||
EndDay | O | Number of the school day represented in EndDate. | xs:unsignedInt | |||||||
FTE | O | Full time equivalent numeric value of the student's course load during this attendance period, expressed in decimal form, where 1.00 represents a full time enrollment. | xs:decimal
| |||||||
DaysAttended | M | The number of days the student attended school when school was in session between the StartDate and EndDate, inclusive. | xs:decimal | |||||||
ExcusedAbsences | M | The number of days the student was absent from school with a valid excuse when school was in session between the StartDate and EndDate, inclusive. | xs:decimal | |||||||
UnexcusedAbsences | M | The number of days the student was absent from school without a valid excuse when school was in session between the StartDate and EndDate, inclusive. | xs:decimal | |||||||
DaysTardy | O | The number of days the student was tardy when school was in session between the StartDate and EndDate, inclusive. | xs:decimal | |||||||
DaysInMembership | M | The number of days the student was present plus the number of days the student was absent when school was in session during the period between the StartDate and EndDate, inclusive. | xs:decimal | |||||||
SIF_Metadata | O | SIF_MetadataType | ||||||||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object provides more detail about the attendance spans for a single student during the day: it provides more detailed information than the single TimeIn and TimeOut elements in StudentDailyAttendance.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
StudentAttendanceTimeList | This object provides more detail about the attendance spans for a single student during the day: it provides more detailed information than the single TimeIn and TimeOut elements in StudentDailyAttendance. | |||
@ | RefId | M | The ID (GUID) that uniquely identifies the instance of the object. | RefIdType |
StudentPersonalRefId | M | The ID (GUID) of the student for whom this attendance information is being reported. | IdRefType | |
SchoolInfoRefId | M | The ID (GUID) of the school for which this attendance information is being reported. | IdRefType | |
Date | M | The calendar date to which this attendance reporting period relates. | xs:date | |
SchoolYear | M | School year for which this enrollment is applicable, expressed as the four-digit year in which the school year ends (e.g. 2007). | SchoolYearType | |
AttendanceTimes | M | Breakdown of times that the student entered or returned to school. | AttendanceTimesType | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
StudentContactPersonal | This object contains information about the people who are referenced as student contacts. | |||
@ | RefId | M | The ID (GUID) that uniquely identifies the instance of the object. | RefIdType |
LocalId | O | The locally-assigned identifier for this person. Note: LocalId may be used as a unique person identifier rather than a unique contact identifier. In this case there may be more than one StudentContactPersonal instance with the same LocalId. | LocalIdType | |
OtherIdList | O | Lists all "other" identifiers associated with the contact. | OtherIdListType | |
PersonInfo | M | Personal Information | PersonInfoType | |
EmploymentType | O | Code that defines employment type. This is compulsory for Parents or Guardians of the Student. | AUCodeSetsEmploymentTypeType | |
SchoolEducationalLevel | O | The highest level of education completed by the contact person. | EducationalLevelType | |
NonSchoolEducation | O | This reflects the level of the Contact's Non-School Education. | AUCodeSetsNonSchoolEducationType | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
StudentContactRelationship | This object defines a relationship between a contact person and a student. | |||
@ | StudentContactRelationshipRefId | M | An ID (GUID) for this paticular student-contact relationship. This GUID would be used to form a REST URL. | IdRefType |
StudentPersonalRefId | M | GUID that identifies the student for the relationship. | RefIdType | |
StudentContactPersonalRefId | M | GUID that identifies the contact person for the relationship. | RefIdType | |
Relationship | M | Defines the relationship of the contact to the student. | RelationshipType | |
ParentRelationshipStatus | O | Confirms whether or not this contact defined in the relationship is to be tracked for MCEECDYA Data Implementation Manual Reporting. | values:
| |
HouseholdList | O | HouseholdList | ||
ContactFlags | C |
Contains Yes/No characteristics of the contact person's role. Provide a | ContactFlagsType | |
MainlySpeaksEnglishAtHome | O | Is English the main language spoken at home? | AUCodeSetsYesOrNoCategoryType | |
ContactSequence | O | Number indicating the order in which the person should be contacted. | xs:unsignedInt | |
ContactSequenceSource | O | Indicates the source who provided the contact sequence order. | AUCodeSetsSourceCodeTypeType | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object provides daily attendance information for a particular student in a particular school on a particular date.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||||
---|---|---|---|---|---|---|---|---|
StudentDailyAttendance | This object provides daily attendance information for a particular student in a particular school on a particular date. | |||||||
@ | RefId | M | The ID (GUID) assigned to uniquely identify this attendance record. | RefIdType | ||||
StudentPersonalRefId | M | The ID (GUID) of the student for whom this attendance information is being reported. | IdRefType | |||||
SchoolInfoRefId | M | The ID (GUID) of the school for which this attendance information is being reported. | IdRefType | |||||
Date | M | The calendar date to which this attendance information relates. | xs:date | |||||
SchoolYear | M |
School year for which this enrollment is applicable, expressed as the four-digit year in which the school year
ends (e.g. | SchoolYearType | |||||
DayValue | O | Value of a day this instance represents. | AUCodeSetsDayValueCodeType | |||||
AttendanceCode | M | Locally defined code for attendance. | AttendanceCodeType | |||||
AttendanceStatus | M | Approved or Unapproved status of this attendance code. | AUCodeSetsAttendanceStatusType | |||||
TimeIn | C | The time the student entered or returned to school. Must be provided if 'Partial' chosen for DayValue. | xs:time | |||||
TimeOut | C | The time the student left school. Must be provided if 'Partial' chosen for DayValue.. | xs:time | |||||
AbsenceValue | C | Must be provided if the DayValue is "Partial" or "Other". The amount of absence represented by AttendanceCode, up to three decimal places. | xs:decimal
| |||||
AttendanceNote | O | Note related to this particular attendance. | xs:normalizedString | |||||
SIF_Metadata | O | SIF_MetadataType | ||||||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object contains information pertaining to student eligibility for and participation in an individualized special program such as special education, ESL, etc.
Multiple instances of this object may be transmitted for a particular student because the student may participate in multiple programs
and because the details of a student's participation in a given program may change over time. A separate instance of this object must be
generated for each program in which the student participates, and the ProgramType
element is used to identify the particular
program. In addition, each time the student's participation profile changes for a particular program, a new instance of this object must
be generated with the appropriate value in the ProgramType
element, the effective date of the new profile in
StudentParticipationAsOfDate
, and a new RefId
.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||||||
---|---|---|---|---|---|---|---|---|---|---|
StudentParticipation | This object contains information pertaining to student eligibility for and participation in an individualized special program such as special education, ESL, etc.
Multiple instances of this object may be transmitted for a particular student because the student may participate in multiple programs
and because the details of a student's participation in a given program may change over time. A separate instance of this object must be
generated for each program in which the student participates, and the | |||||||||
@ | RefId | M | This is the unique identification code | RefIdType | ||||||
StudentPersonalRefId | M | The GUID of the student that this object is linked to. | IdRefType | |||||||
StudentParticipationAsOfDate | M |
Effective date (NOT the entry date) of this | xs:date | |||||||
ProgramType | O | Identifies the individualised program for which the student's participation is described in this instance | AUCodeSetsStudentFamilyProgramTypeType | |||||||
ProgramFundingSources | O | List of funding sources | ProgramFundingSourcesType | |||||||
ManagingSchool | M | The GUID of the school responsible for coordinating the student's program participation. | IdRefType | |||||||
@ | SIF_RefObject | M | values:
| |||||||
ReferralDate | O | Date student was referred for evaluation/program participation. | xs:date | |||||||
ReferralSource | O | ReferralSourceType | ||||||||
ProgramStatus | O | The current status of the student's program participation. | ProgramStatusType | |||||||
GiftedEligibilityCriteria | O | Eligible for Gifted / Talented program? | AUCodeSetsYesOrNoCategoryType | |||||||
EvaluationParentalConsentDate | O | Date parent(s) consented to completion of evaluation of child for program participation. | xs:date | |||||||
EvaluationDate | O | Date the evaluation/assessment process for student was completed. | xs:date | |||||||
EvaluationExtensionDate | O | Actual date by which evaluation must be completed (for state use in determining timeliness in event that parent and LEA agreed to an extension beyond normal state deadline). | xs:date | |||||||
ExtensionComments | O | Contains any comments on the extension. Optional even if an EvaluationExtensionDate is present. | xs:string | |||||||
ReevaluationDate | O | Date students will be reevaluated for continued placement in a support program(s). | xs:date | |||||||
ProgramEligibilityDate | O | Date student is eligible for beginning the support program(s). | xs:date | |||||||
ProgramPlanDate | O | Date the most recent program plan was completed and approved by the team responsible for developing it. The date the parent consented to placement is NOREPDate. | xs:date | |||||||
ProgramPlanEffectiveDate | O | Date by which the plan must be implemented for the student. | xs:date | |||||||
NOREPDate | O | Date the Notice of Recommended Educational Placement was signed and approved by the parent / guardian of the student. | xs:date | |||||||
PlacementParentalConsentDate | O | Date the parent(s) consented to the proposed placement. | xs:date | |||||||
ProgramPlacementDate | O | Date student began the support program. | xs:date | |||||||
ExtendedSchoolYear | O | For special education, indicates whether Extended School Year (ESY) / summer services have been determined as necessary | xs:boolean | |||||||
ExtendedDay | O | For special education, indicates whether Extended School Day (ESD) services have been determined as necessary. | xs:boolean | |||||||
ProgramAvailability | O | ProgramAvailabilityType | ||||||||
EntryPerson | O | Identification / name of the person who created the transaction that led to the creation of this instance of the object. | xs:normalizedString | |||||||
StudentSpecialEducationFTE | O | Calculated ratio of time the student is in a special ed setting. Values range from 0.00 to 1.00. If the student is in a special ed setting 25% of the time, the value is .25; if 100% of the time, the value is 1.00. | xs:decimal
| |||||||
ParticipationContact | O | Primary contact for this record. | xs:normalizedString | |||||||
SIF_Metadata | O | SIF_MetadataType | ||||||||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object allows recording of period level attendance for a student. The Australian StudentPeriodAttendance object differs to the US StudentPeriodAttendance object in the following ways:
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
StudentPeriodAttendance | This object allows recording of period level attendance for a student. The Australian StudentPeriodAttendance object differs to the US StudentPeriodAttendance object in the following ways:
| |||
@ | RefId | M | The ID (GUID) assigned to uniquely identify this attendance record. | RefIdType |
StudentPersonalRefId | M | The GUID of the student that this attendance applies to. | IdRefType | |
SchoolInfoRefId | M | The school where the attendance was recorded. Somewhat redundant, needed for requests. | IdRefType | |
Date | M | The date of the attendance event. | xs:date | |
SessionInfoRefId | O | The GUID of the session that this attendance applies to. | IdRefType | |
TimetablePeriod | O | The period within which attendance is being reported, e.g. "4D". | xs:normalizedString | |
TimeIn | O | The time the student entered or returned to this class. | xs:time | |
TimeOut | O | The time the student left this class. | xs:time | |
AttendanceCode | M | Code that describes the absence or attendance | AttendanceCodeType | |
AttendanceStatus | M | Approved or Unapproved status of this attendance code. | AUCodeSetsAttendanceStatusType | |
SchoolYear | O |
School year for which this enrollment is applicable, expressed as the four-digit year in which the school year
ends (e.g. | SchoolYearType | |
AuditInfo | O | An audit trail to help determine who entered this attendance event and when. | AuditInfoType | |
AttendanceComment | O | This element contains the comments that are relevant to this attendance record. | xs:string | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object contains all the personal information related to the student.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
StudentPersonal | This object contains all the personal information related to the student. | |||
@ | RefId | M | The GUID of the student. | RefIdType |
AlertMessages | O | AlertMessagesType | ||
MedicalAlertMessages | O | MedicalAlertMessagesType | ||
LocalId | M | The locally-assigned identifier for this student. | LocalId | |
StateProvinceId | O | The state-assigned identifier for this student. | StateProvinceId | |
ElectronicIdList | O | Electronic identifier(s) associated with this entity. | ElectronicIdListType | |
OtherIdList | O | Lists all "other" identifiers associated with the student. | OtherIdListType | |
PersonInfo | M | Personal Information | PersonInfoType | |
ProjectedGraduationYear | O | Currently projected graduation year. | ProjectedGraduationYearType | |
OnTimeGraduationYear | O | First projected graduation year, usually determined when student is accepted into 9th grade. | OnTimeGraduationYearType | |
GraduationDate | O | Date student officially graduated from secondary education. | GraduationDateType | |
MostRecent | O | Container for elements reflecting the most recent enrollment of a student. If the student is currently enrolled in the district, the elements contain current information. | StudentMostRecentContainerType | |
AcceptableUsePolicy | O | Does the student have a current signed Acceptable Use Policy document for system access? | AUCodeSetsYesOrNoCategoryType | |
GiftedTalented | O | AUCodeSetsYesOrNoCategoryType | ||
EconomicDisadvantage | O | Does the student meet the State criteria for classification as having an economic disadvantage? | AUCodeSetsYesOrNoCategoryType | |
ESL | O | Does the student meet 'English as a Second Language Criteria'? | AUCodeSetsYesOrNoCategoryType | |
ESLDateAssessed | O | Date ESL eligibility was assessed. Having access to the date the last ESL assessment took place enables a school or the department to initiate a new assessment if required. | xs:date | |
YoungCarersRole | O | Is the student a carer of other family members? | AUCodeSetsYesOrNoCategoryType | |
Disability | O | Does the student have funding for disability? | AUCodeSetsYesOrNoCategoryType | |
IntegrationAide | O | Does the Student require an Integration Aide? | AUCodeSetsYesOrNoCategoryType | |
EducationSupport | O | Is the student in receipt of education support? | AUCodeSetsYesOrNoCategoryType | |
HomeSchooledStudent | O | Student is not attending any school registered in the Australian School List. Mandatory if true. | AUCodeSetsYesOrNoCategoryType | |
Sensitive | O | For local use by jurisdictions where a court order, custody order or other restriction or risk exists and the student's record needs to be treated sensitively as restrictions on use apply. | AUCodeSetsYesOrNoCategoryType | |
OfflineDelivery | O | Note that the student is unable to sit an assessment via an online delivery mode. | AUCodeSetsYesOrNoCategoryType | |
PrePrimaryEducation | O | Care prior to kinder enrolment (eg. Family day care/home/extended care etc). | xs:normalizedString | |
FirstAUSchoolEnrollment | O | Date of the first enrolment in an Australian School | xs:date | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object defines information related to a student's enrollment. StudentSchoolEnrollment instances must not span multiple school years.
Note there is only one current home enrollment at a time per student.
Only one instance of the StudentSchoolEnrollment
object must exist for a given student with MembershipType
=01
(Home School) and TimeFrame
=C
(Current)
for the time interval between EntryDate
and ExitDate
, inclusive.
Agents are required to re-publish a StudentSchoolEnrollment
object Change
event when the
TimeFrame
attribute changes, regardless of when the data entry is done.
This is in addition to the practice of publishing the object Change
event at the time the data changes in the corresponding application.
When the object is re-published, it must contain all the data in the object that is supported by the publisher.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||||||
---|---|---|---|---|---|---|---|---|---|---|
StudentSchoolEnrollment | This object defines information related to a student's enrollment. StudentSchoolEnrollment instances must not span multiple school years.
Note there is only one current home enrollment at a time per student.
Only one instance of the
Agents are required to re-publish a When the object is re-published, it must contain all the data in the object that is supported by the publisher. | |||||||||
@ | RefId | M | The ID (GUID) that uniquely identifies a particular enrollment. | RefIdType | ||||||
StudentPersonalRefId | M | The ID (GUID) of the student to whom this information is linked. | IdRefType | |||||||
SchoolInfoRefId | M | The ID (GUID) of the school to which this enrollment applies. | IdRefType | |||||||
MembershipType | M | The type of this enrollment as it relates to the school identified in SchoolInfoRefId. | AUCodeSetsSchoolEnrollmentTypeType | |||||||
LocalId | O | The locally-assigned identifier for this student enrollment. | LocalId | |||||||
TimeFrame | M |
The timeframe of the enrollment based on the | AUCodeSetsEnrollmentTimeFrameType | |||||||
SchoolYear | M |
School year for which this enrollment is applicable, expressed as the four-digit year in which the school year ends (e.g. | SchoolYearType | |||||||
EntryDate | M | The date from when this enrollment is valid. | xs:date | |||||||
EntryType | O | Container elements for EntryType information | StudentEntryContainerType | |||||||
YearLevel | O | Year or academic level of student. | YearLevelType | |||||||
Homeroom | O | Homeroom for this enrollment. | IdRefType | |||||||
@ | SIF_RefObject | M | The name of the object referenced. | values:
| ||||||
Advisor | O | Staff member assigned as an advisor. | IdRefType | |||||||
@ | SIF_RefObject | M | The name of the object referenced. | values:
| ||||||
Counselor | O | Staff member assigned as an advisor. | IdRefType | |||||||
@ | SIF_RefObject | M | The name of the object referenced. | values:
| ||||||
Homegroup | O | The name of the homegroup the student enrollment belongs to. | xs:normalizedString | |||||||
ACARASchoolId | O | ACARA School Id. | LocalIdType | |||||||
ClassCode | O | The name of the class code the student belongs to, for the purposes of NAPLAN registration. | xs:normalizedString | |||||||
TestLevel | O | Values: 3,5,7,9. The test level that the student is registering for. | YearLevelType | |||||||
ReportingSchool | O | Is this the school to which student's report is to be made available? | AUCodeSetsYesOrNoCategoryType | |||||||
House | O | The name of the house the student belongs to. | xs:normalizedString | |||||||
IndividualLearningPlan | O | Does this student have an individual learning plan in place? | AUCodeSetsYesOrNoCategoryType | |||||||
Calendar | O | The calendar assigned to this enrollment. | IdRefType | |||||||
@ | SIF_RefObject | M | The name of the object referenced. | values:
| ||||||
ExitDate | C |
The last school calendar day of this enrollment. If the student has exited the school or the enrollment has a | xs:date | |||||||
ExitStatus | O | Container element for exit status codes. | StudentExitStatusContainerType | |||||||
ExitType | O | StudentExitContainerType | ||||||||
FTE | O | Full-time equivalent numeric value of the student's course load during this enrollment, expressed in decimal form, where 1.00 represents a full-time enrollment. | xs:decimal
| |||||||
FTPTStatus | O | An indication of whether the student is enrolled full time or part time. | AUCodeSetsFTPTStatusCodeType | |||||||
FFPOS | O | Enrolled Full-fee Paying Overseas Student (FFPOS) Status. Enrolment Frame Element 10 NSCC Collection. The status of an enrolment in a CRICOS course and whether the person is liable for a fee which reflects the imputed full average cost of the person's education at the school (including both recurrent and capital costs) irrespective of the actual arrangements to meet the fee. | AUCodeSetsFFPOSStatusCodeType | |||||||
CatchmentStatus | O | Container element for location of an individual's legal residence relative to (within or outside) the boundaries of the school for this enrolment. Enrolment Catchment Status. | CatchmentStatusContainerType | |||||||
RecordClosureReason | O | The reason why this enrollment was closed. The EndOfYear option must be used to convey status change due to rollover activity. | values:
| |||||||
PromotionInfo | O | Information on a student's promotion, retention, or demotion related to this enrollment instance. | PromotionInfoType | |||||||
PreviousSchool | O | If the student has previously been enrolled at a school, i.e. student is transferring, the previous school number. | LocalIdType | |||||||
DestinationSchool | O | If the student has exited the school, the local id of the school to which the student has transferred to. | LocalIdType | |||||||
StudentSubjectChoiceList | O | List of Student Subject Choices where available. | StudentSubjectChoiceListType | |||||||
SIF_Metadata | O | SIF_MetadataType | ||||||||
SIF_ExtendedElements | O | 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 | 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 | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
The SystemRole Object defines the systems that a user has access to, the roles they perform within those systems, and the scope of those roles within the particular system.
The RoleScopeList is used to list the entities over which the user has access rights.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SystemRole | The SystemRole Object defines the systems that a user has access to, the roles they perform within those systems, and the scope of those roles within the particular system. The RoleScopeList is used to list the entities over which the user has access rights. | |||
@ | RefId | M | The SIF RefId that uniquely identifies this object. | RefIdType |
SIF_RefId | M | The SIF RefId that provides the source Object for this SystemRole Object. | IdRefType | |
@ | SIF_RefObject | M | The type of SIF object that the SIF_RefId attribute identifies. | values:
|
SystemContextList | M | At least one SystemContext must be provided. | List | |
SystemContextList/SystemContext | MR | Details about enterprise roles for an Identity/Personal Object for subscribing systems | ||
@ | SystemId | M | Id of the system that this SystemContext relates to. | xs:normalizedString |
SystemContextList/SystemContext/ RoleList | O | List of Roles. | List | |
SystemContextList/SystemContext/ RoleList/Role | MR | Role of the entity this object describes in the SystemContext. | ||
@ | RoleId | M | Role of the entity this object describes in the SystemContext. Examples | xs:normalizedString |
SystemContextList/SystemContext/ RoleList/Role/RoleScopeList | O | List | ||
SystemContextList/SystemContext/ RoleList/Role/RoleScopeList/ RoleScope | MR | Container | ||
SystemContextList/SystemContext/ RoleList/Role/RoleScopeList/ RoleScope/RoleScopeName | C | The group/OU this role is applicable to. One of RoleScopeName or associated RefId must be provided. | xs:normalizedString | |
SystemContextList/SystemContext/ RoleList/Role/RoleScopeList/ RoleScope/RoleScopeRefId | C | The SIF_RefId that provides the source Object for this RoleScope. One of RoleScopeName or associated RefId must be provided. | IdRefType | |
@ | SIF_RefObject | M | The type of SIF object that the SIF_RefId attribute identifies. | values:
|
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | 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 | Description | Type | |
---|---|---|---|---|
TeachingGroup | This object identifies a particular Teaching Group or class in a particular a time table. The proposed object is based on the UK B1: TeachingGroup object. For the Australian object, a subject being taught at any one year level can have more than one teaching group in any one time table. Also a teaching group can be brought together for more than one subject. All local ids in non-authoritative objects are optional. It is therefore up to the provider and the actual agent's design and choreography to determine whether or not to use or local ids from parent objects. There are cases in some subscribing systems where it might not possible to add RefId columns and therefore the RefId of related objects cannot be stored. For example a target system that listens to TimeTableSubject events and updates them may not be able to store the associated SchoolCourseInfoRefId with that object. The only way it can link the TimeTableSubject object with the appropriate course might be through its local course id. Having local ids that link the parent objects with the child object can simplify the agent design. Generally it is suggested to use the appropriate RefIds whenever possible and only use local ids if there is no other way to use RefIds. | |||
@ | RefId | M | The GUID of the TeachingGroup | RefIdType |
SchoolYear | M | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007"). | SchoolYearType | |
LocalId | M | LocalId of the Teaching Group (previously ClassIndicator). | LocalIdType | |
ShortName | M | Short free format label that describes the group. | xs:normalizedString | |
LongName | O | Longer description if required. | xs:normalizedString | |
GroupType | O | Added to allow local implmentations 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 | Set Number (UK) | xs:normalizedString | |
Block | O | Block (UK) | xs:normalizedString | |
CurriculumLevel | O | Assessment Stage eg VELS Level | xs:normalizedString | |
SchoolInfoRefId | O | GUID of SchoolInfo object this teaching group belongs to. | RefIdType | |
SchoolLocalId | O | Local School Id. | LocalIdType | |
SchoolCourseInfoRefId | O | GUID of SchoolCourseInfo object this teaching group is part of. | RefIdType | |
SchoolCourseLocalId | O | Local Course Id. | LocalIdType | |
TimeTableSubjectRefId | O | GUID of TimeTableSubject object this teaching group belongs to. | RefIdType | |
TimeTableSubjectLocalId | O | Local subject Id. | LocalIdType | |
Semester | O | Semester, Term, or Quarter subject offered. | xs:unsignedInt | |
StudentList | O | List of Students in this Teaching Group | StudentListType | |
TeacherList | O | A List of teachers associated with the group – may or may not include the teacher timetabled in the schedule. | TeacherListType | |
MinClassSize | O | Minimum class size. | xs:integer | |
MaxClassSize | O | Maximum class size | xs:integer | |
TeachingGroupPeriodList | O | 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 | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object provides information about a term; i.e., a reportable period of time.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||||||
---|---|---|---|---|---|---|---|---|---|---|
TermInfo | This object provides information about a term; i.e., a reportable period of time. | |||||||||
@ | RefId | M | The ID (GUID) that uniquely identifies this TermInfo entity. | RefIdType | ||||||
SchoolInfoRefId | M | The ID (GUID) that identifies the school where the term is used. | IdRefType | |||||||
SchoolYear | M | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2009"). | SchoolYearType | |||||||
StartDate | M | Starting date of the term. | xs:date | |||||||
EndDate | M | Ending date of the term. | xs:date | |||||||
Description | O | Text-based description of the term. | xs:normalizedString | |||||||
RelativeDuration | O | Portion of the school year represented by this term, expressed in decimal form precise to 4 decimal places (e.g., 0.1333). | xs:decimal
| |||||||
TermCode | O | Locally-defined code. | xs:normalizedString | |||||||
Track | O | The name, description, or code of the track that contains this term. This is used when there are multiple tracks within a school. For instance, kindergarten commonly has a different set of terms than other grades within the school. | xs:normalizedString | |||||||
TermSpan | O | What sort of Session this TermSpan equates to. | AUCodeSetsSessionTypeType | |||||||
MarkingTerm | O | Does this TermInfo represent a marking period? | AUCodeSetsYesOrNoCategoryType | |||||||
SchedulingTerm | O | Does this TermInfo represent a scheduling term? | AUCodeSetsYesOrNoCategoryType | |||||||
AttendanceTerm | O | Does this TermInfo represent an attendance term? | AUCodeSetsYesOrNoCategoryType | |||||||
SIF_Metadata | O | SIF_MetadataType | ||||||||
SIF_ExtendedElements | O | 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 | Description | Type | |
---|---|---|---|---|
TimeTable | The purpose of this object is to define a schedule or Time Table structure/skeleton for the school. The Time Table is produced by the Time Tabling software. Once the Time Table is produced, the time tabling software creates the schedule based on business rules and constraints to fit into the time table structure. The proposed Time Table object is based on a combination of the proposed UK B6 – Timetable Cycle Object and Timetable Scope Object. The Time Table is identified uniquely in the SIF Zone by its GUID, School and School Year. A Time Table is linked to a particular school. All local ids in non-authoritative objects are optional. It is therefore up to the provider and the actual agent's design and choreography to determine whether or not to use or local ids from parent objects. There are cases in some subscribing systems where it might not possible to add RefId columns and therefore the RefId of related objects cannot be stored. For example a target system that listens to TimeTableSubject events and updates them may not be able to store the associated SchoolCourseInfoRefId with that object. The only way it can link the TimeTableSubject object with the appropriate course might be through its local course id. Having local ids that link the parent objects with the child object can simplify the agent design. Generally it is suggested to use the appropriate RefIds whenever possible and only use local ids if there is no other way to use RefIds. | |||
@ | RefId | M | GUID that identifies this TimeTable object. | RefIdType |
SchoolInfoRefId | O | Optional, the GUID of the SchoolInfo Object if this object is known in the zone. | IdRefType | |
SchoolYear | M | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007"). | SchoolYearType | |
LocalId | O | Local TimeTable ID | LocalIdType | |
Title | M | Unique Name of the proposed Time Table | xs:normalizedString | |
DaysPerCycle | M | Max Number of days per Time Table cycle | xs:unsignedInt | |
PeriodsPerDay | M | Max Number of periods per Time Table Day | xs:unsignedInt | |
TeachingPeriodsPerDay | O | Teaching periods per day if different to PeriodsPerDay | xs:unsignedInt | |
SchoolLocalId | O | Optional Local School Id | LocalIdType | |
SchoolName | O | The school name in plain text. | xs:normalizedString | |
TimeTableCreationDate | O | Date Schedule was created or last edited. | xs:date | |
StartDate | O | First day of TimeTable. | xs:date | |
EndDate | O | Last day of the TimeTable. | xs:date | |
TimeTableDayList | M | Container for TimeTableDays in Schedule | TimeTableDayListType | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | 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 | Description | Type | |
---|---|---|---|---|
TimeTableCell | The purpose of this object is to identify a specific cell within a particular TimeTable. A time table is a structure that represents all the available days and times (periods) for which a particular teaching group, or subject can be scheduled. A TimeTableCell is uniquely identified in the ZIF zone by its GUID. And the following must be provided at object creation:
All local ids in non-authoritative objects are optional. It is therefore up to the provider and the actual agent's design and choreography to determine whether or not to use or local ids from parent objects. There are cases in some subscribing systems where it might not possible to add RefId columns and therefore the RefId of related objects cannot be stored. For example a target system that listens to TimeTableSubject events and updates them may not be able to store the associated SchoolCourseInfoRefId with that object. The only way it can link the TimeTableSubject object with the appropriate course might be through its local course id. Having local ids that link the parent objects with the child object can simplify the agent design. Generally it is suggested to use the appropriate RefIds whenever possible and only use local ids if there is no other way to use RefIds. | |||
@ | RefId | M | The GUID of the TimeTableCell | RefIdType |
TimeTableRefId | M | The GUID of the TimeTable to which this Cell belongs | IdRefType | |
TimeTableSubjectRefId | M | The GUID of the Subject that this Cell is scheduling | IdRefType | |
TeachingGroupRefId | M | The GUID of the TeachingGroup being scheduled | IdRefType | |
RoomInfoRefId | M | The GUID of the Resource being Scheduled | IdRefType | |
StaffPersonalRefId | O | The GUID of the Staff Member being Scheduled | IdRefType | |
TimeTableLocalId | O | Time Table Local Identifier | LocalIdType | |
SubjectLocalId | O | Subject Local Id | LocalIdType | |
TeachingGroupLocalId | O | Teaching Group | LocalIdType | |
RoomNumber | O | Room number as presented to the user/application. | HomeroomNumberType | |
StaffLocalId | O | Staff LocalId | LocalIdType | |
DayId | M | Day Id | LocalIdType | |
PeriodId | M | Period Id within the Day Id | LocalIdType | |
CellType | M | Type of Lesson/Session eg Teaching, Lunch etc | xs:normalizedString | |
SchoolInfoRefId | O | Optional, the GUID of the SchoolInfo Object if this object is known in the zone | IdRefType | |
SchoolLocalId | O | Optional, Local School Id | LocalIdType | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | 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 | Description | Type | |
---|---|---|---|---|
TimeTableSubject | This purpose of this object is to define and communicate the subject or distinct piece of curriculum that needs to be scheduled by the time table generator. This is a new object proposed to meet SIF-AU needs. Reviews of the existing specifications identified two relevant objects - SchoolCourseInfo, defined in SIF US 2.2 specification and SchoolGroup, defined within the SIF UK 1.1 specification. These objects appear to have some similar context but seem overly complex considering that Australian requirements, which are limited to the Student Administration System or Curriculum Delivery System providing base information to the Time Tabling application about what curriculum offerings are being proposed. When this data is sent in a Request/Response only those subjects that are relevant to be scheduled (or active), should be sent to the TimeTabling application. All local ids in non-authoritative objects are optional. It is therefore up to the provider and the actual agent's design and choreography to determine whether or not to use or local ids from parent objects. There are cases in some subscribing systems where it might not possible to add RefId columns and therefore the RefId of related objects cannot be stored. For example a target system that listens to TimeTableSubject events and updates them may not be able to store the associated SchoolCourseInfoRefId with that object. The only way it can link the TimeTableSubject object with the appropriate course might be through its local course id. Having local ids that link the parent objects with the child object can simplify the agent design. Generally it is suggested to use the appropriate RefIds whenever possible and only use local ids if there is no other way to use RefIds. | |||
@ | RefId | M | GUID that identifies this TimeTableSubject. | RefIdType |
SubjectLocalId | M | SubjectLocalID - Distinct piece of curriculum that is to be scheduled. | LocalIdType | |
AcademicYear | C | Subject Year Level. Either AcademicYear or AcademicYearRange must be provided. | YearLevelType | |
AcademicYearRange | C | Range of Academic Years subject spans. Either AcademicYear or AcademicYearRange must be provided. | YearRangeType | |
CourseLocalId | O | Local Course Id, if associated with a Course. | LocalIdType | |
SchoolCourseInfoRefId | O | The GUID of the SchoolCourseInfo object. | RefIdType | |
Faculty | O | Faculty | xs:normalizedString | |
SubjectShortName | O | SubjectShortName | xs:normalizedString | |
SubjectLongName | M | SubjectLongName | xs:normalizedString | |
SubjectType | O | Core or Elective or ? | xs:normalizedString | |
ProposedMaxClassSize | O | Suggested maximum class size for this subject. | xs:decimal | |
ProposedMinClassSize | O | Suggested minimum class size for this subject. | xs:decimal | |
SchoolInfoRefId | O | Optional the GUID of the SchoolInfo Object if this object is known in the zone. | IdRefType | |
SchoolLocalId | O | Optional Local School Id | LocalIdType | |
Semester | O | Semester, Term, or Quarter subject offered. | xs:unsignedInt | |
SchoolYear | O | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007"). | SchoolYearType | |
OtherCodeList | O | Any other codes this subject is known by; eg VASS code for VCE in Vic. | OtherCodeListType | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |
This object contains basic vendor information (commonly known as creditors).
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
VendorInfo | This object contains basic vendor information (commonly known as creditors). | |||
@ | RefId | M | Vendor Id. | RefIdType |
Name | M | Name of the vendor. | xs:normalizedString | |
ContactInfo | O | Contact information. | ContactInfoType | |
CustomerId | O | Account number or other Id. | xs:normalizedString | |
ABN | O | Australian Business Number. | xs:normalizedString | |
RegisteredForGST | O | The vendor is registered to collect GST. | AUCodeSetsYesOrNoCategoryType | |
PaymentTerms | O | The vendors payment terms (typically expressed as number of days e.g. 14 days). | xs:normalizedString | |
BPay | O | BPay Id. | xs:normalizedString | |
BSB | O | Vendor's BSB number. | xs:normalizedString | |
AccountNumber | O | Vendor's account number. | xs:normalizedString | |
AccountName | O | Vendor's account name. | xs:normalizedString | |
SIF_Metadata | O | SIF_MetadataType | ||
SIF_ExtendedElements | O | SIF_ExtendedElementsType |