This represents objects that allow schools to securely provide SIS information to the Attendance product of their choice, and also to allow school attendance records to be published to a jurisdictional data hub, recording attendance at varying degrees of granularity.
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 | Privacy Rating | Description | Type | |
|---|---|---|---|---|---|
| CalendarDate | Low | 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 | Low | 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 | Low | A specific school day that occurs within the school year. | xs:date | |
| CalendarSummaryRefId | O | Low | The ID (GUID) of the calendar summary in which this calendar date is. | IdRefType | |
| SchoolInfoRefId | M | Low | The ID (GUID) of the school for which this calendar information is being reported. | IdRefType | |
| SchoolYear | M | Low | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2009"). | SchoolYearType | |
| CalendarDateType | M | Low | Calendar date type information. | CalendarDateInfoType | |
| CalendarDateNumber | O | Low | Order in which the calendar date falls within the school calendar. | xs:unsignedInt | |
| StudentAttendance | O | Low | Information describing how the day relates to student attendance. | AttendanceInfoType | |
| TeacherAttendance | O | Low | Information describing how the day relates to teacher attendance. | AttendanceInfoType | |
| AdministratorAttendance | O | Low | Information describing how the day relates to administrator attendance. | AttendanceInfoType | |
| LocalCodeList | O | Low | LocalCodeListType | ||
| SIF_Metadata | O | Low | SIF_MetadataType | ||
| SIF_ExtendedElements | O | Low | 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 | Privacy Rating | Description | Type | |
|---|---|---|---|---|---|
| CalendarSummary | Low | 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 | Low | The ID (GUID) of the calendar to which this information relates. | RefIdType |
| SchoolInfoRefId | M | Low | The ID (GUID) of the school for which this calendar information is being reported. | IdRefType | |
| SchoolYear | M | Low | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007"). | SchoolYearType | |
| LocalId | M | Low | The locally assigned identifier for this calendar. | LocalIdType | |
| Description | O | Low | Textual description of the school calendar. | xs:string | |
| DaysInSession | M | Low | 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 | Low | 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 | Low | 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 | Low | The first day of student instruction. | xs:date | |
| LastInstructionDate | O | Low | 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 | Low | Date of graduation ceremony. | GraduationDateType | |
| InstructionalMinutes | O | Low | The total number of instructional minutes for this calendar for the school year. | xs:unsignedInt | |
| MinutesPerDay | O | Low | The number of minutes in the day in which the school is normally in session. | xs:unsignedInt | |
| YearLevels | O | Low | Collection of year levels applicable to this school calendar. | YearLevelsType | |
| LocalCodeList | O | Low | LocalCodeListType | ||
| SIF_Metadata | O | Low | SIF_MetadataType | ||
| SIF_ExtendedElements | O | Low | 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 | Privacy Rating | Description | Type | |
|---|---|---|---|---|---|
| SessionInfo | Low | 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 | Low | The GUID of the Object | RefIdType |
| SchoolInfoRefId | M | Low | The ID (GUID) of the school for which this attendance information is being reported. | IdRefType | |
| TimeTableCellRefId | M | Low | The (GUID) of the piece of Curriculum (TT Grid) scheduled | IdRefType | |
| SchoolYear | M | Low | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2007"). | SchoolYearType | |
| LocalId | M | Low | Session Local Identifier | LocalIdType | |
| TimeTableSubjectLocalId | M | Low | TimeTableSubject Local Identifier | LocalIdType | |
| TeachingGroupLocalId | M | Low | Teaching Group Local Identifier | LocalIdType | |
| SchoolLocalId | O | Low | School Local Identifier | LocalIdType | |
| StaffPersonalLocalId | O | Low | Staff Local Identifier | LocalIdType | |
| RoomNumber | C | Low | Room number as presented to the user or application. Needs to be provided if changed from TimeTableCell. | xs:normalizedString | |
| DayId | M | Low | Day Id. | LocalIdType | |
| PeriodId | M | Low | Period Id within the Day Id | LocalIdType | |
| SessionDate | M | Low | Date of Session | xs:date | |
| StartTime | O | Low | Optional Start Time | xs:time | |
| FinishTime | O | Low | Optional End Time | xs:time | |
| RollMarked | O | Low | Was the Roll Marked for this Period? | AUCodeSetsYesOrNoCategoryType | |
| LocalCodeList | O | Low | LocalCodeListType | ||
| SIF_Metadata | O | Low | SIF_MetadataType | ||
| SIF_ExtendedElements | O | Low | 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 | Privacy Rating | Description | Type | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| StudentAttendanceSummary | Low | 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 | M | Low | 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 | Low | The ID (GUID) of the student for whom this attendance information is being reported. | IdRefType | |||||||
| SchoolInfoRefId | M | Low | The ID (GUID) of the school for which this attendance information is being reported. | IdRefType | |||||||
| SchoolYear | M | Low | School year for which the information is applicable. | SchoolYearType | |||||||
| StartDate | M | Low | Starting date of this attendance reporting period. | xs:date | |||||||
| EndDate | M | Low | Ending date of this attendance reporting period. | xs:date | |||||||
| StartDay | O | Low | Number of the school day represented in StartDate. | xs:unsignedInt | |||||||
| EndDay | O | Low | Number of the school day represented in EndDate. | xs:unsignedInt | |||||||
| FTE | O | Low | 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 | Low | The number of days the student attended school when school was in session between the StartDate and EndDate, inclusive. | xs:decimal | |||||||
| ExcusedAbsences | M | Low | 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 | Low | 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 | Low | The number of days the student was tardy when school was in session between the StartDate and EndDate, inclusive. | xs:decimal | |||||||
| DaysInMembership | M | Low | 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 | |||||||
| LocalCodeList | O | Low | LocalCodeListType | ||||||||
| SIF_Metadata | O | Low | SIF_MetadataType | ||||||||
| SIF_ExtendedElements | O | Low | 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 | Privacy Rating | Description | Type | |
|---|---|---|---|---|---|
| StudentAttendanceTimeList | Low | 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 | Low | The ID (GUID) that uniquely identifies the instance of the object. | RefIdType |
| StudentPersonalRefId | M | Low | The ID (GUID) of the student for whom this attendance information is being reported. | IdRefType | |
| SchoolInfoRefId | M | Low | The ID (GUID) of the school for which this attendance information is being reported. | IdRefType | |
| Date | M | Low | The calendar date to which this attendance reporting period relates. | xs:date | |
| SchoolYear | M | Low | 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 | Low | Breakdown of times that the student entered or returned to school. | AttendanceTimesType | |
| PeriodAttendances | O | Low | List of any period attendances that need to be captured as part of a full list of student attendance types. | PeriodAttendancesType | |
| LocalCodeList | O | Low | LocalCodeListType | ||
| SIF_Metadata | O | Low | SIF_MetadataType | ||
| SIF_ExtendedElements | O | Low | 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 | Privacy Rating | Description | Type | |||||
|---|---|---|---|---|---|---|---|---|---|
| StudentDailyAttendance | Extreme | This object provides daily attendance information for a particular student in a particular school on a particular date. | |||||||
| @ | RefId | M | Low | The ID (GUID) assigned to uniquely identify this attendance record. | RefIdType | ||||
| StudentPersonalRefId | M | Medium | The ID (GUID) of the student for whom this attendance information is being reported. | IdRefType | |||||
| SchoolInfoRefId | M | Low | The ID (GUID) of the school for which this attendance information is being reported. | IdRefType | |||||
| Date | M | Low | The calendar date to which this attendance information relates. | xs:date | |||||
| SchoolYear | M | Low |
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 | Low | Value of a day this instance represents. | AUCodeSetsDayValueCodeType | |||||
| AttendanceCode | M | Extreme | Locally defined code for attendance. | AttendanceCodeType | |||||
| AttendanceStatus | M | Low | Approved or Unapproved status of this attendance code. | AUCodeSetsAttendanceStatusType | |||||
| TimeIn | C | Low | The time the student entered or returned to school. Must be provided if 'Partial' chosen for DayValue. | xs:time | |||||
| TimeOut | C | Low | The time the student left school. Must be provided if 'Partial' chosen for DayValue. | xs:time | |||||
| AbsenceValue | C | Low | 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 | Extreme | Note related to this particular attendance. | xs:normalizedString | |||||
| LocalCodeList | O | Extreme | LocalCodeListType | ||||||
| SIF_Metadata | O | Extreme | SIF_MetadataType | ||||||
| SIF_ExtendedElements | O | Extreme | 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 | Privacy Rating | Description | Type | |
|---|---|---|---|---|---|
| StudentPeriodAttendance | Extreme | 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 | Low | The ID (GUID) assigned to uniquely identify this attendance record. | RefIdType |
| StudentPersonalRefId | M | Low | The GUID of the student that this attendance applies to. | IdRefType | |
| SchoolInfoRefId | M | Low | The school where the attendance was recorded. Somewhat redundant, needed for requests. | IdRefType | |
| Date | M | Low | The date of the attendance event. | xs:date | |
| SessionInfoRefId | O | Low | The GUID of the session that this attendance applies to. | IdRefType | |
| ScheduledActivityRefId | O | Low | The GUID of the ScheduledActivity Object attendance applies to. | IdRefType | |
| TimetablePeriod | O | Low | The period within which attendance is being reported, e.g. "4D". | xs:normalizedString | |
| TimeIn | O | Low | The time the student entered or returned to this class. | xs:time | |
| TimeOut | O | Low | The time the student left this class. | xs:time | |
| AttendanceCode | M | Extreme | Code that describes the absence or attendance | AttendanceCodeType | |
| AttendanceStatus | M | Low | Approved or Unapproved status of this attendance code. | AUCodeSetsAttendanceStatusType | |
| SchoolYear | O | Low |
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 | Low | An audit trail to help determine who entered this attendance event and when. | AuditInfoType | |
| AttendanceComment | O | Extreme | This element contains the comments that are relevant to this attendance record. | xs:string | |
| LocalCodeList | O | Extreme | LocalCodeListType | ||
| SIF_Metadata | O | Extreme | SIF_MetadataType | ||
| SIF_ExtendedElements | O | Extreme | SIF_ExtendedElementsType |