xRosters
http://www.sifassociation.org/datamodel/na/3.5
Documentation
xRoster is a composite object that provides a consolidated view of information related to a course section or class, including student enrollment and assigned staff. The refId of a xRoster object coincides with the refId of a corresponding section object.
Service Paths
xLeas/{}/xRosters : Returns the rosters/sections in the specified LEA.
xStaffs/{}/xRosters : Returns the rosters/sections assigned to the given staff memeber.
xStudents/{}/xRosters : Returns the rosters/sections for which the specified student is enrolled.
xCourses/{}/xRosters : Returns the rosters/sections of the specified course.
xSections/{}/xRosters : Returns the rosters for a particular section.
Tree
Table
Name | Mandatory | Characteristics | Type | Description | XPath |
---|---|---|---|---|---|
@refId | * | gRefIdType | /xRosters/xRoster/@refId | ||
xRoster | any | /xRosters/xRoster | |||
courseRefId | O | gRefIdPointerType | RefId of the course for this section. | /xRosters/xRoster/courseRefId | |
courseTitle | O | token | The descriptive name given to a course of study offered in a school or other institution or organization. In departmentalized classes at the elementary, secondary, and postsecondary levels (and for staff development activities), this refers to the name by which a course is identified (e.g., American History, English III). For elementary and other non-departmentalized classes, it refers to any portion of the instruction for which a grade or report is assigned (e.g., reading, composition, spelling, and language arts). | /xRosters/xRoster/courseTitle | |
sectionRefId | O | gRefIdPointerType | RefId of the section. | /xRosters/xRoster/sectionRefId | |
subject | O | xSubjectType | /xRosters/xRoster/subject | ||
schoolRefId | * | M | gRefIdPointerType | RefId of the school. | /xRosters/xRoster/schoolRefId |
schoolSectionId | O | token | A unique number or alphanumeric code assigned by an institution, school, school system, state, or other agency or entity for a particular course-section. | /xRosters/xRoster/schoolSectionId | |
schoolYear | O | xSchoolYearType | The year for a reported school session. | /xRosters/xRoster/schoolYear | |
timeTableDay | O | token | The unique identifier for the locally defined rotation cycle date code when the class meets (e.g., in a two day schedule, valid values could be "A" and "B", or "1" and "2"). | /xRosters/xRoster/meetingTimes/meetingTime/timeTableDay | |
bellScheduleDay | O | xDayOfWeekType | /xRosters/xRoster/meetingTimes/meetingTime/classMeetingDays/bellScheduleDay | ||
timeTablePeriod | O | token | An indication of the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, or AB schedules). | /xRosters/xRoster/meetingTimes/meetingTime/timeTablePeriod | |
roomNumber | O | token | A unique number or alphanumeric code assigned to a room by a school, school system, state, or other agency or entity. | /xRosters/xRoster/meetingTimes/meetingTime/roomNumber | |
classBeginningTime | O | time | An indication of the time of day the class begins. | /xRosters/xRoster/meetingTimes/meetingTime/classBeginningTime | |
classEndingTime | O | xExitOrWithdrawalType | An indication of the time of day the class ends. | /xRosters/xRoster/meetingTimes/meetingTime/classEndingTime | |
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. | /xRosters/xRoster/meetingTimes/meetingTime/sessionCode | |
schoolCalendarRefId | O | gRefIdPointerType | The RefId of the school calendar. | /xRosters/xRoster/meetingTimes/meetingTime/schoolCalendarRefId | |
refId | * | M | gRefIdPointerType | A SIF RefId. | /xRosters/xRoster/students/studentReference/refId |
localId | O | xPersonIdType | /xRosters/xRoster/students/studentReference/localId | ||
givenName | O | normalizedString | The full legal first name given to a person at birth, baptism, or through legal change. | /xRosters/xRoster/students/studentReference/givenName | |
familyName | O | normalizedString | The full legal last name borne in common by members of a family. | /xRosters/xRoster/students/studentReference/familyName | |
refId | * | M | gRefIdPointerType | A SIF RefId. | /xRosters/xRoster/primaryStaff/staffPersonReference/refId |
localId | O | xPersonIdType | /xRosters/xRoster/primaryStaff/staffPersonReference/localId | ||
givenName | O | normalizedString | The full legal first name given to a person at birth, baptism, or through legal change. | /xRosters/xRoster/primaryStaff/staffPersonReference/givenName | |
familyName | O | normalizedString | The full legal last name borne in common by members of a family. | /xRosters/xRoster/primaryStaff/staffPersonReference/familyName | |
teacherOfRecord | O | boolean | Staff member who has a Teacher of Record responsibility for a Class Section based upon the state's definition of Teacher of Record. | /xRosters/xRoster/primaryStaff/teacherOfRecord | |
percentResponsible | O | decimal | A percentage used to weight the educator's assigned responsibility for student learning in a Class Section, particularly when more than one educator is assigned to the class section. | /xRosters/xRoster/primaryStaff/percentResponsible | |
refId | * | M | gRefIdPointerType | A SIF RefId. | /xRosters/xRoster/otherStaffs/otherStaff/staffPersonReference/refId |
localId | O | xPersonIdType | /xRosters/xRoster/otherStaffs/otherStaff/staffPersonReference/localId | ||
givenName | O | normalizedString | The full legal first name given to a person at birth, baptism, or through legal change. | /xRosters/xRoster/otherStaffs/otherStaff/staffPersonReference/givenName | |
familyName | O | normalizedString | The full legal last name borne in common by members of a family. | /xRosters/xRoster/otherStaffs/otherStaff/staffPersonReference/familyName | |
teacherOfRecord | O | boolean | Staff member who has a Teacher of Record responsibility for a Class Section based upon the state's definition of Teacher of Record. | /xRosters/xRoster/otherStaffs/otherStaff/teacherOfRecord | |
percentResponsible | O | decimal | A percentage used to weight the educator's assigned responsibility for student learning in a Class Section, particularly when more than one educator is assigned to the class section. | /xRosters/xRoster/otherStaffs/otherStaff/percentResponsible |
Download: .xlsx (with CEDS & Formats)
Structure