xCalendars
http://www.sifassociation.org/datamodel/na/3.5
Documentation
xCalendar is a composite object that provides information about sessions held at a particular school during a given school year. The refId of a xCalendar object coincides with the refId of a corresponding schoolCalendar object.
Service Paths
xSchools/{}/xCalendars : Returns the calendar of sessions for a school by school year.
Tree
Table
Name | Mandatory | Characteristics | Type | Description | XPath |
---|---|---|---|---|---|
@refId | * | gRefIdType | /xCalendars/xCalendar/@refId | ||
xCalendar | any | /xCalendars/xCalendar | |||
schoolRefId | * | M | gRefIdPointerType | The refid to which this calendar applies. | /xCalendars/xCalendar/schoolRefId |
schoolYear | O | xSchoolYearType | The school year for the calendar. | /xCalendars/xCalendar/schoolYear | |
sessionType | O | xSessionTypeType | A prescribed span of time when an education institution is open, instruction is provided, and students are under the direction and guidance of teachers and/or education institution administration. A session may be interrupted by one or more vacations. | /xCalendars/xCalendar/sessions/sessionList/sessionType | |
sessionCode | O | token | A local code given to the session, usually for a session that represents a term within the school year such as a marking term. | /xCalendars/xCalendar/sessions/sessionList/sessionCode | |
description | O | string | A short description of the Session. | /xCalendars/xCalendar/sessions/sessionList/description | |
markingTerm | O | boolean | Indicates that the session is a marking term. | /xCalendars/xCalendar/sessions/sessionList/markingTerm | |
schedulingTerm | O | boolean | Indicates that the session is a scheduling term. | /xCalendars/xCalendar/sessions/sessionList/schedulingTerm | |
linkedSessionCode | O | token | Enables sessions to be linked (e.g. link a marking term to a scheduling term) | /xCalendars/xCalendar/sessions/sessionList/linkedSessionCode | |
startDate | * | M | date | The year, month and day on which a session begins. | /xCalendars/xCalendar/sessions/sessionList/startDate |
endDate | O | date | The year, month and day on which a session ends. | /xCalendars/xCalendar/sessions/sessionList/endDate |
Download: .xlsx (with CEDS & Formats)
Structure