This section presents the XML structure for SIF Data Model common elements and objects in a tabular format for readers less versed in parsing formal XML schema definitions, along with conventions that typically apply in the data model for easy reference.
The Char(acteristics) column for all of the tables in this section use the following codes:
Code | Characteristic |
M | Mandatory element or attribute |
O | Optional element or attribute |
C | Conditional element or attribute |
MR | Mandatory and repeatable element |
OR | Optional and repeatable element |
CR | Conditional and repeatable element |
Mandatory elements MUST be present in Add events, and
in non-empty and non-error responses to requests for entire SIF objects (e.g., no SIF_Query/SIF_QueryObject/SIF_Element
elements supplied in the request).
Mandatory attributes MUST always be present if their corresponding element is present.
SIF Agents and Zone Integration Servers MUST supply data according to the types specified in the Type columns and their corresponding equivalents in the most recent schema files associated with this specification. If there is a discrepancy between object and element definitions in this specification and the corresponding schema files, the definition in the schema files takes precedence; every effort will be made to note discrepancies in the errata for this document as they are identified.
While XML attributes are primarily used in SIF to provide additional processing information regarding the associated element content,
attributes at the root level of an object have special significance. These attributes serve as the primary
key or identifier for the object; in many cases this is no more than a RefId
GUID of RefIdType
, though the primary key may consist solely of
foreign key references to other SIF objects and include school years, dates, etc. These key attributes are immutable over the lifetime of an object
and serve the purpose of uniquely identifying an object, especially
in Change
and Delete
events. Some groups include non-primary key attributes in object attributes (e.g. mandatory
foreign key references to other objects) and attributes that provide additional processing information regarding the objects. As SIF currently
mandates that all object attributes be included in all messages, when a SIFA working group or task force places a non-primary key attribute
in the object's attribute definitions (typically out of historical query conventions), they are indicating that this value must still be accessible
to systems in Change
and, more notably, Delete
events. All object attributes must be supplied to identify the object
in Change
and Delete
events.
As stated elsewhere, SIF primarily uses GUIDs as object identifiers, primary keys, or RefId
s. References to primary keys (foreign key references)
follow certain conventions in SIF in most objects:
IdRefType
can be defined that consists of the referenced object name
concatenated with RefId
, e.g., StudentPersonalRefId
(a reference to the object identifier/primary key/RefId
of a StudentPersonal
object);
IdRefType
, has an element name of a group's choosing (or generically SIF_RefId
) and enumerates all possible object types that can be referenced
in the SIF_RefObject
attribute; or
IdRefType
containing the referenced object's RefId
, the other enumerating
all possible object types that can be referenced; generically these are named SIF_RefId
and SIF_RefObject
, respectively;
naming conventions that programmatically allow identification of the pair beyond the generic names will be documented when the need arises.
To those accustomed with normalized relational databases, the SIF Data Model will appear to not be especially normalized, especially with regard to
repeating groups of data not being separated into their own "tables," or in SIF's case, "objects" with primary/foreign keys to maintain the
relationship. Bear in mind that SIF is not a format for storing
data; it is a format for transmitting data asynchronously between disparate and distributed systems needing to share data for
interoperability; the format this data takes in different systems can vary greatly, and the data related to any given "entity" may
come from a variety of sources and systems.
The goals of normalization—eliminating redundancy, organizing data efficiently, reducing inconsistencies, etc.—take on a different meaning in
a message queuing system. Of primary importance is transmitting the data needed for interoperability in a minimum number of messages. The need to "join" together
a great number of separate objects is kept to a minimum in SIF, as individual systems do not have access to all the data required and due to the asynchronous
nature of SIF, any one of these systems may take a fair amount of time before returning data necessary for joins (SIF_ExtendedQuery
has been
developed to communicate a join to a single system that may have direct access to the all the data necessary to efficiently accomplish this task). It's one
thing to make a separate request for a student's picture or enrollment information, another entirely to request every available phone number, address and e-mail
address separately from the SIF Zone. As such, it is often the case in SIF that repeating data is stored directly in an object, rather than being separated
out into a separate object.
Repeating data is very analogous to objects, though, within any given object. In SIF's Publish/Subscribe model, repeating elements in objects
can be added to, changed in or deleted from an object, much like objects can be added to, changed in or deleted from a Zone. Within an existing object, all of these
actions take place within a Change
event, and repeating elements—if any exist initially—are first made available within an object in an Add
event or can be obtained directly via requests. Repeatable elements are contained within a parent List element in most SIF objects
whether or not they support events, e.g.:
Two types of list are currently defined in SIF, ActionList and List; both consist of a list container element and a single repeatable child element. Each type of list serves different needs and has associated conventions for communication and processing in the SIF Publish/Subscribe Model. List or ActionList is specified in the Type column in tables in this section for each list; when an ActionList the key, possibly compound, is also indicated.
An ActionList has a key that uniquely identifies each child element within the list. This type of list is primarily used when it is
desirable or necessary for systems to support or refer to a subset of the list, either due to functionally only being able to support a subset
or because specifying a subset in Change
events is more efficient than transmitting a whole list as in List.
While one system may support the Primary
and
Alternate1
e-mail address types above, another may additionally support Alternate2
addresses. The second system
is able to communicate the addition, change or deletion of an Alternate2
address without the first system inadvertently interpreting
that to mean a student or staff member's Primary
and Alternate1
addresses have been deleted.
Systems communicate the whole list as a cohesive unit consisting of the parent list container element and all child elements in an Add
event; if the container is present with no child elements, the list is empty; the same is implied when an optional list is not present in an
Add
event. In a Change
event, systems SHOULD only transmit those elements that have been added, changed or deleted. Deletion
is not implied by the omission of a child element, but rather explicitly communicated with a SIF_Action
attribute of Delete
added to the deleted element, along with the element's key attribute(s)/element(s) at a minimum. An empty list in a Change
event implies
no changes have occurred in the list, as does the omission of the list. Systems storing ActionList data should set/replace/delete any
existing values identified by primary keys in the Change
event they support.
A system that supports an Alternate2
e-mail makes no changes to its value for that address type.
While a unique, primary key may still be identifiable in its child elements, a List is used primarily when:
Lists are always transmitted as a cohesive unit consisting of the parent list container element and all child elements. If no child
elements exist in the list, the list consists of the container element alone. Omission of an optional List in an Add
event
also implies no list items. In a Change
event, omission of the List indicates no changes have been made; otherwise the
parent container element and all child elements, if any, are included. Systems storing
List data should replace all corresponding data in their systems when persisting the list; likewise when a change is made to one or more
list items or when all items in the list are deleted, systems should send the whole list in a Change
event.
A system that supports CountriesOfCitizenship
updates its local data to reflect U.S. and German citizenship.
Some agents follow the convention of supplying an optional element as empty (e.g. <BirthDate></BirthDate>
or <BirthDate/>
to indicate
that the application supports the element, but that it currently has no value available within a given object. To allow for this convention within SIF—as in this example
an empty string does not satisfy the xs:date
type definition of BirthDate
—all optional elements in SIF
are defined as nillable
[SCHEMA]. To satisfy type constraints on an element while still supplying an empty or "nil"
value, agents MUST tag the element with a true
value for the nil
attribute from namespace
http://www.w3.org/2001/XMLSchema-instance
[SCHEMA] (e.g. <BirthDate xsi:nil="true"/>
where the prefix xsi
has been mapped to
the namespace http://www.w3.org/2001/XMLSchema-instance
), unless an empty value is valid with regard to the element's type definition,
in which case supplying the nil
attribute value of true
is optional.
See SIF and XML Namespaces for more details on namespaces, and SIF and XML Schema
for more details on SIF's use of XML Schema.
Note that XML not defined within SIF does not necessarily support ad hoc omission of XML elements at will to conform with the conventions of the SIF Publish/Subscribe Model (where unchanged elements are typically omitted in Change events, and where non-key elements are often omitted in Delete events) or of the SIF Request/Response Model (where a subset of elements can be retrieved from objects with requests). If externally-defined XML occurs within a SIF data object, SIF conventions do not extend to that XML unless that XML is defined to accommodate SIF conventions; the XML, when transmitted, must only conform to any external definitions dictating its structure, if any. Applications should be prepared for the possibility of receiving whole externally-defined XML structures in Change events (regardless of how little or much of the external XML has changed) and possibly also Delete events, likewise in responses even when a subset of the XML structure's child elements may have explicitly been requested.
This element represents an address. This element occurs within objects and elements such as StaffPersonal and StudentPersonal/StudentAddress, etc.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
Address | M | This element contains address data. | ||
@ | Type | M | Code that defines the location of the address. Note: A subset of specific valid values for each instance in a data object may be listed in that object. | NCES0025AddressTypeType |
Street | M | The street element is a complex element and breaks the street down into several parts. | ||
Street/Line1 | M | Address line 1. | xs:normalizedString | |
Street/Line2 | O | Address line 2. | xs:normalizedString | |
Street/Line3 | O | Address line 3. | xs:normalizedString | |
Street/Complex | O | Name of the complex. | xs:normalizedString | |
Street/StreetNumber | O | The address number assigned to the building. | xs:normalizedString | |
Street/StreetPrefix | O | Street prefix like NE | xs:normalizedString | |
Street/StreetName | O | The name of the street. | xs:normalizedString | |
Street/StreetType | O | The type of street. For example, Lane, Blvd., Ave., etc. | xs:normalizedString | |
Street/StreetSuffix | O | Street suffix like SW. | xs:normalizedString | |
Street/ApartmentType | O | Type of apartment, for example, Suite. | xs:normalizedString | |
Street/ApartmentNumberPrefix | O | Apartment number prefix. | xs:normalizedString | |
Street/ApartmentNumber | O | The number of the apartment. | xs:normalizedString | |
Street/ApartmentNumberSuffix | O | Apartment number suffix. | xs:normalizedString | |
City | M | The city part of the address. | xs:normalizedString | |
County | O | The county part of the address. | xs:normalizedString | |
StateProvince | M | The state or province code. | StateProvince | |
Country | M | The country code. | Country | |
PostalCode | M | The ZIP/postal code. | xs:normalizedString | |
GridLocation | O | The location of the address. | GridLocation |
A list of Address elements.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
AddressList | A list of Address elements. | ActionList (Address/@Type) | ||
Address | MR | Address | ||
@ | SIF_Action | O |
In a | values:
|
A person's date of birth.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
BirthDate | A person's date of birth. | xs:date |
Common element used to indicate the number of the U.S. Congressional District in which an entity resides or is physically located.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
CongressionalDistrict | Number for the US congressional district. While typically numerical, this element does allow for text values to cover exceptions, e.g. to indicate an "at-large" district as in Wyoming. | union of: xs:unsignedInt xs:token |
Common element used to supply information for a contact person at a school, LEA, or other institution.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
ContactInfo | Common element used to supply information for a contact person at a school, LEA, or other institution. | |||
Name | M |
The name of the contact person. Note that | ||
@ | Type | M |
Code that specifies what type of name this is. If unsure, use | values:
|
Name/Prefix | O | A prefix associated with the name like Mr., Ms., etc. | xs:normalizedString | |
Name/LastName | O | The last name. | LastName | |
Name/FirstName | O | The first name. | FirstName | |
Name/MiddleName | O | The middle name or initial. | MiddleName | |
Name/Suffix | O | Generation of suffix like II, Jr., etc. | xs:normalizedString | |
Name/PreferredName | O | This is a name that the person prefers to be called by. | xs:normalizedString | |
Name/SortName | O | This is the name to be used for sorting purposes. | xs:normalizedString | |
Name/FullName | C |
A free text field for the complete name. Mandatory if | xs:normalizedString | |
PositionTitle | O | The contact person's position title. Examples | xs:normalizedString | |
Role | O | Role played by this contact in this instance. Examples | xs:normalizedString | |
Address | O | Address of the contact. | Address | |
EmailList | O | List of Email elements. | EmailList | |
PhoneNumberList | O | List of PhoneNumber elements. | PhoneNumberList |
A country code.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
Country | A country code. | union of: ISO31661EnglishCountryNamesAndCodeElementsType ISO31663CodeForFormerlyUsedNamesOfCountriesType |
School-defined local code for a course.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
CourseCode | School-defined local code for a course. | xs:normalizedString |
The number of credits awarded upon course completion.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
CourseCredits | The number of credits awarded upon course completion. | xs:decimal | ||
@ | Type | M | The type of credit offered. | NCES0108CreditTypeEarnedType |
Title of a course.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
CourseTitle | Title of a course. | xs:normalizedString |
Demographics information about the student, contact, staff member, etc. This element occurs within objects such as StudentPersonal, StudentContact, etc.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
Demographics | Demographics information about the student, contact, staff member, etc. This element occurs within objects such as StudentPersonal, StudentContact, etc. | |||
RaceList | O | RaceList | ||
HispanicLatino | O | HispanicLatino | ||
Gender | O | Person's gender. | Gender | |
BirthDate | O | The person's date of birth. | BirthDate | |
BirthDateVerification | O | Means by which the person's birth date was validated. | NCES0315BirthdateVerificationType | |
PlaceOfBirth | O | The person's place of birth—like village, town, city etc. | xs:normalizedString | |
CountyOfBirth | O | The county in which the person was born. | xs:normalizedString | |
StateOfBirth | O | The person's state of birth. | StateProvince | |
CountryOfBirth | O | The person's country of birth. | Country | |
CountriesOfCitizenship | O | List | ||
CountriesOfCitizenship/CountryOfCitizenship | MR | A person's country of citizenship. | Country | |
CountriesOfResidency | O | List | ||
CountriesOfResidency/CountryOfResidency | MR | A person's country of residence. | Country | |
CountryArrivalDate | O | Date the person first arrived in the country. | xs:date | |
CitizenshipStatus | O | The person's citizenship status. | NCES0322CitizenshipStatusType | |
EnglishProficiency | O | |||
EnglishProficiency/Code | M | Person's proficiency in English. | NCES0585EnglishProficiencyType | |
EnglishProficiency/OtherCodeList | O | OtherCodeList | ||
LanguageList | O | List | ||
LanguageList/Language | MR | |||
LanguageList/Language/Code | M | The code representing the specific language that an individual uses to communicate. | NISOZ3953LanguageCodesType | |
LanguageList/Language/OtherCodeList | O | OtherCodeList | ||
LanguageList/Language/LanguageType | O | An indication of the function and context in which an individual uses a language to communicate. | NCES0327LanguageTypeType | |
LanguageList/Language/Dialect | O | Specific dialect of a person's language. | xs:normalizedString | |
DwellingArrangement | O | Setting/environment in which the person resides. | ||
DwellingArrangement/Code | M | Code representing the setting/environment in which the person resides | NCES0600DwellingArrangementType | |
DwellingArrangement/OtherCodeList | O | OtherCodeList | ||
MaritalStatus | O | The person's marital status. | NCES0330MaritalStatusType |
A district course code.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
DistrictCourseCode | A district course code. | xs:normalizedString |
This gives information about a staff member's meal status.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
EarnedStatus | This gives information about a staff member's meal status. | |||
@ | Type | M | Earned status type.
In SIF objects
where the EarnedStatus is required and does not apply, | values:
|
StartDate | O | Date on which earned status became effective (inclusive). | xs:date | |
EndDate | C | Date on which earned status was last in effect. This attribute is conditional upon the StartDate element. It exists only if the StartDate element exists. | xs:date |
Does the student meet the State criteria for classification as having an economic disadvantage?
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
EconomicDisadvantage | Does the student meet the State criteria for classification as having an economic disadvantage? | values:
|
A code representing the highest level of education completed by a person.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
EducationalLevel | A code representing the highest level of education completed by a person. | NCES0332HighestLevelOfEducationCompletedType |
Common element used to specify entity identifiers that are read by electronic equipment. It is used in objects such as StudentPersonal, StaffPersonal, and LibraryPatronStatus.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
ElectronicId | Common element used to specify entity identifiers that are read by electronic equipment. It is used in objects such as StudentPersonal, StaffPersonal, and LibraryPatronStatus. | xs:normalizedString | ||
@ | Type | M | Electronic ID type. | values:
|
A list of electronic identifiers associated with an entity.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
ElectronicIdList | A list of electronic identifiers associated with an entity. | List | ||
ElectronicId | MR | ElectronicId |
Is the student an English Language Learner under Title 3?
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
ELL | Is the student an English Language Learner under Title 3? | values:
|
This element represents an e-mail address of one of a number of types and occurs in objects such as StudentPersonal, StaffPersonal, StudentContact, etc.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
This element represents an e-mail address of one of a number of types and occurs in objects such as StudentPersonal, StaffPersonal, StudentContact, etc. | xs:normalizedString | |||
@ | Type | M | This attribute specifies the type of e-mail address. | values:
|
A list of e-mail addresses associated with an individual.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
EmailList | A list of e-mail addresses associated with an individual. | ActionList (Email/@Type) | ||
MR | ||||
@ | SIF_Action | O |
In a | values:
|
Common element used to specify the date on which a student enters a school, program, course section, etc. It is used in objects such as StudentSchoolEnrollment and StudentSectionEnrollment.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
EntryDate | The first date on which a student enters. | xs:date |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
ExceptionalityCategories | List | |||
ExceptionalityCategory | MR | |||
ExceptionalityCategory/Code | M |
Exceptionality description/code which identifies the exceptionality or areas of need of the student.
Not all programs require identification of an exceptionality.
If required for this program type, must have at least one element with ExceptionalityPriority value of | union of: NCES0768PrimaryDisabilityTypeType additional values:
| |
ExceptionalityCategory/OtherCodeList | O | OtherCodeList | ||
ExceptionalityCategory/ExceptionalityPriority | M | Identifies priority of the exceptionality. "Primary" is the first and is required even if only one exceptionality is specified. "Secondary", etc. are of lower priority. Primary, Secondary, and Tertiary must be specified before "Additional" is used. | values:
|
Common element used to specify the date on which a student exits a school, program, course section, etc. It is used in objects such as StudentSchoolEnrollment and StudentSectionEnrollment.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
ExitDate | The date on which a student exits. | xs:date |
A person's first name.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
FirstName | A person's first name. | xs:normalizedString |
A person's gender.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
Gender | O | A person's gender. | values:
|
Is the student in Gifted/Talented programs?
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
GiftedTalented | Is the student in Gifted/Talented programs? | values:
|
This is a common element used to specify a grade level. It is used in StudentSchoolEnrollment and assessment-related objects.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
GradeLevel | Grade or academic level. | |||
Code | M | Code representing the grade level. | values:
| |
OtherCodeList | O | OtherCodeList |
This is a common element used to specify a collection of grade levels supported. It is used in SchoolInfo and assessment-related objects.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
GradeLevels | This is a common element used to specify a collection of grade levels supported. It is used in SchoolInfo and assessment-related objects. | List | ||
GradeLevel | MR | GradeLevel |
Date student officially graduated from secondary education.
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
GraduationDate | Date student officially graduated from secondary education. | |||||
Year | M | Year of graduation (CCYY). | xs:gYear | |||
Month | O | Month of graduation (MM). | xs:token
| |||
Day | O | Day of graduation (DD). | xs:token
|
Does the state require that the course be completed for graduation?
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
GraduationRequirement | Does the state require that the course be completed for graduation? | values:
|
This element contains a map location. The GridLocation element is utilized within other objects and elements, such as BusStopInfo and Address, etc.
Element/@Attribute | Char | Description | Type | |||||
---|---|---|---|---|---|---|---|---|
GridLocation | This element contains a map location. The GridLocation element is utilized within other objects and elements, such as BusStopInfo and Address, etc. | |||||||
Latitude | M | Latitude in decimal degrees. Latitudes north of the equator are positive, latitudes south of the equator are negative [ISO 6709]. | xs:decimal
| |||||
Longitude | M | Longitude in decimal degrees. Longitudes east of the Prime Meridian in Greenwich are positive, longitudes west of the Prime Meridian are negative. The 180th meridian is negative. [ISO 6709] | xs:decimal
|
An indication that the individual traces his or her origin or descent to Mexico, Puerto Rico, Cuba, Central or South America, or other Spanish cultures, regardless of race.
Is the student homeless?
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
Homeless | Is the student homeless? | values:
|
Common element used to specify the locally-defined number or identifier for a homeroom. It is used in objects such as RoomInfo and StudentSnapshot.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
HomeroomNumber | Common element used to specify the locally-defined number or identifier for a homeroom. It is used in objects such as RoomInfo and StudentSnapshot. | xs:normalizedString |
Is the student IDEA-eligible ("special education")? (Mutually exclusive with Section 504 classification.)
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
IDEA | Is the student IDEA-eligible ("special education")? (Mutually exclusive with Section 504 classification.) | values:
|
Other identification information associated with a school or LEA.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
IdentificationInfo | Other identification information associated with a school or LEA. | xs:normalizedString | ||
@ | Code | Code indicating which identification system is used. | NCES0147IdentificationSystemType subset:
|
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
IdentificationInfoList | List | |||
IdentificationInfo | MR | Other identification information associated with a school or LEA. | IdentificationInfo |
Does the student meet the State criteria for classification as being an immigrant?
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
Immigrant | Does the student meet the State criteria for classification as being an immigrant? | values:
|
An indication of the general nature and difficulty of instruction provided.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
InstructionalLevel | An indication of the general nature and difficulty of instruction provided. | |||
Code | M | Code representing the general nature and difficulty of instruction provided. | NCES0437InstructionalLevelType | |
OtherCodeList | O | OtherCodeList |
A person's last name.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
LastName | A person's last name. | xs:normalizedString |
Name of Local Education Agency.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
LEAName | Name of Local Education Agency. | xs:normalizedString |
This is a common element used to define the locally assigned identifier associated with an entity. It is used in StudentPersonal, StaffPersonal, SchoolInfo, and other objects.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
LocalId | This is a common element used to define the locally assigned identifier associated with an entity. It is used in StudentPersonal, StaffPersonal, SchoolInfo, and other objects. | xs:normalizedString |
This gives information about a student's meal status.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
MealStatus | This gives information about a student's meal status. | |||
@ | Type | M | Meal status type.
| values:
|
StartDate | O | Date on which meal status became effective (inclusive). | xs:date | |
EndDate | C |
Date on which meal status was last in effect, if in the past.
This element can't exist without a | xs:date | |
SchoolYear | O |
School year for which the information is applicable, expressed as the four-digit year in which the school year ends
(e.g., | SchoolYear |
This gives information about a meal type.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
MealType | This gives information about a meal type. | values:
|
This element represents the meeting times and periods for a course, and occurs within objects such as SectionInfo and StudentSectionEnrollment.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
MeetingTime | This element represents the meeting times and periods for a course, and occurs within objects such as SectionInfo and StudentSectionEnrollment. | |||
TimetableDay | O | Locally defined rotation cycle day code when the section meets (e.g., in a two day schedule, valid values would be "A" and "B," or "1" and "2"). | xs:normalizedString | |
TimetablePeriod | O | The period within the day when this section takes place (e.g., "0" through "7"). | xs:normalizedString |
A person's middle name or initial.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
MiddleName | A person's middle name or initial. | xs:normalizedString |
Is this a migrant student?
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
Migrant | Is this a migrant student? | values:
|
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
Name | The Name element, which could belong to a student, staff member, contact, etc. This element or a form with a subset of Type values occurs within objects such as StudentPersonal, StudentContact, StaffPersonal, etc. | BaseNameType | ||
@ | Type | M |
Code that specifies what type of name this is. If unsure, use | values:
|
This is a common element used to define the identifier assigned by the National Center for Education Statistics that is associated with an entity. It is used in SchoolInfo, LEAInfo, and other objects.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
NCESId | This is a common element used to define the identifier assigned by the National Center for Education Statistics that is associated with an entity. It is used in SchoolInfo, LEAInfo, and other objects. | xs:normalizedString |
Is the student participating in programs for neglected, delinquent, or at risk children?
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
NeglectedDelinquent | Is the student participating in programs for neglected, delinquent, or at risk children? | values:
|
First projected graduation year, usually determined when student is accepted into 9th grade (CCYY).
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
OnTimeGraduationYear | First projected graduation year, usually determined when student is accepted into 9th grade (CCYY). | xs:gYear |
This common element contains status information about a school, LEA, or other institution.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
OperationalStatus | Operational condition of an institution. For schools, use 0256 School Status Type. For LEAs, use 0032 Agency Status. | union of: NCES0256SchoolStatusType NCES0032AgencyStatusType |
List of other codes or strings that crosswalk to or serve as translations of the Code
element paired with this common element. If Code
changes
and OtherCode
s are supported, both Code
and all associated OtherCode
elements must be present.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
OtherCodeList |
List of other codes or strings that crosswalk to or serve as translations of the | List | ||
OtherCode | MR |
A state/province code, local code, other code or a text string that crosswalks to or serves as a translation of an associated | xs:token | |
@ | Codeset | M |
Describes the | values:
|
An "other" identifier associated with a person. This element occurs in objects such as StudentPersonal and StaffPersonal, etc.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
OtherId | An "other" identifier associated with a person. This element occurs in objects such as StudentPersonal and StaffPersonal, etc. | xs:normalizedString | ||
@ | Type | M | Code that defines the type of this other ID. Note: A subset of valid values may be specified in data objects. | NCES0147IdentificationSystemType |
Previous, alternate or other names or aliases associated with a person.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
OtherNames | O | Previous, alternate or other names or aliases associated with a person. | ActionList (Name/@Type) | |
Name | MR |
Name of the person. Note: Type value of | OtherNameType | |
@ | SIF_Action | O |
In a | values:
|
This element represents a phone number and occurs within objects such as StudentPersonal, StaffPersonal, etc.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
PhoneNumber | This element represents a phone number and occurs within objects such as StudentPersonal, StaffPersonal, etc. | |||
@ | Type | M | Code that specifies what type of phone number this is. Note: A subset of valid values may be specified in data objects. | NCES0280TelephoneNumberTypeType |
Number | M | Phone number. Free-form, but typical U.S. formats include:
| xs:normalizedString | |
Extension | O | Phone number extension. | xs:normalizedString | |
ListedStatus | O | Indicates whether or not the phone number is available to the public. | values:
|
Lists phone numbers associated with an entity.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
PhoneNumberList | Lists phone numbers associated with an entity. | ActionList (PhoneNumber/@Type) | ||
PhoneNumber | MR | PhoneNumber | ||
@ | SIF_Action | O |
In a | values:
|
The student's planned level of participation in statewide assessments.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
PlannedAssessmentParticipation | The student's planned level of participation in statewide assessments. Examples | xs:token | ||
@ | Codeset | Identifies source of value provided. | values:
|
This common element is used to describe program information. It uses a type attribute that provides a list of values that identify programs. Each use of this common element should specify the standard list of values to be utilized within that object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
Program | Program value. | xs:normalizedString | ||
@ | Type | M | The type of the program. Type identifies the list of values. | values:
|
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
ProgramStatus | ||||
Code | M | The current status of the student's program participation. | values:
| |
OtherCodeList | O | OtherCodeList |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
ProgramType | ||||
Code | M | Identifies the individualized program for which the student's participation is described in this instance. | union of: NCES0274StudentFamilyProgramTypeType subset:
NCES0229ProgramTypeType subset:
additional values:
| |
OtherCodeList | O | OtherCodeList |
Currently projected graduation year.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
ProjectedGraduationYear | Currently projected graduation year (CCYY). | xs:gYear |
This is a common element used to specify whether or not information (e.g., contact information) should be published in a directory. It is used in the SchoolInfo and LEAInfo objects.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
PublishInDirectory | Indicates whether or not information should be published in a directory. | values:
|
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
RaceList | List | |||
Race | MR | |||
Race/Code | M | The general racial category which reflects the individual's recognition of his or her community or with which the individual most identifies. | NCES0849RaceType | |
Race/OtherCodeList | O | OtherCodeList | ||
Race/Proportion | O | A percentage associated with the race. | xs:decimal |
Code that defines the relationship of one person to another.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
Relationship | Code that defines the relationship of one person to another. | |||
Code | M | Code representing the relationship. | NCES0609RelationshipToStudentType | |
OtherCodeList | O | OtherCodeList |
Course code from the School Codes for the Exchange of Data that describe the content of the course.
Element/@Attribute | Char | Description | Type | |||||
---|---|---|---|---|---|---|---|---|
SCEDCode | Course code from the School Codes for the Exchange of Data that describe the content of the course. | |||||||
CourseDescription | M | Five-digit number. Subject areas are represented by the first two digits, the last three digits specify a particular course within the subject area. | xs:token
| |||||
CourseLevel | M | Conveys the level of the course. | values:
| |||||
AvailableCredit | M | Identifies the amount of credit available to a student who successfully meets the objectives of the course, measured in Carnegie units (9.99 format). | xs:decimal
| |||||
SequenceNumber | M | One-digit number describing where a specific course lies when it is part of a consecutive sequence of courses described by the same general course description. | xs:unsignedInt
| |||||
SequenceLimit | M | One-digit number representing the total number of courses in the consecutive sequence described by the same general course description. | xs:unsignedInt
|
A list of contact persons associated with a school.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SchoolContactList | A list of contact persons associated with a school. | List | ||
SchoolContact | MR | Information on contact persons for this school. | ||
SchoolContact/PublishInDirectory | O | Indicates whether or not this school contact's information should be published in a directory of school information. | PublishInDirectory | |
SchoolContact/ContactInfo | M | ContactInfo |
Common element used to specify the name of a school. It is used in objects such as SchoolInfo and StudentSnapshot.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SchoolName | The name of the school. | xs:normalizedString |
URL for a school.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SchoolURL | URL for a school. | xs:anyURI |
Common element used to designate the academic school year to which an object relates.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SchoolYear | School year for which this information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2004" for the 2003-04 school year). | xs:gYear |
Is the student a qualified individual under Section 504 of the Rehabilitation Act? (Mututally exclusive with IDEA classification.)
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
Section504 | Is the student a qualified individual under Section 504 of the Rehabilitation Act? (Mututally exclusive with IDEA classification.) | values:
|
This element is supported at the end of all SIF objects. The element is used to extend existing SIF objects with locally-defined elements. Extended elements SHOULD NOT be used to duplicate data that can be obtained from other SIF objects.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SIF_ExtendedElements | Allows an agent to include data not yet defined within a SIF data object as name/value pairs. | ActionList (SIF_ExtendedElement/@Name) | ||
SIF_ExtendedElement | OR | A name/value pair, the name being contained in the Name attribute, the value being the element content. | ExtendedContentType | |
@ | Name | M | The name of the extended element. As it is possible that names for extended elements may collide from agent to agent, it is recommended that the names of extended elements be configurable in an agent, or that agents use URIs for the names of extended elements. | xs:normalizedString |
@ | xsi:type | O | Allows type of element to be explicitly communicated. | |
@ | SIF_Action | O |
In a | values:
|
Social Security Number
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SSN | Social Security Number | xs:token |
State-defined standard course code used to report information about courses.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
StateCourseCode | State-defined standard course code used to report information about courses. | xs:normalizedString |
A state or province code. Note: When dealing with countries other than the United States or Canada, state/province codes/values other than those referenced here can be used.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
StateProvince | A state or province code. Note: When dealing with countries other than the United States or Canada, state/province codes/values other than those referenced here can be used. | union of: USPSAbbreviationsType CanadaPostProvincesAndTerritoriesType xs:token |
This is a common element used to define the state or province assigned identifier associated with an entity. It is used in StudentPersonal, StaffPersonal, and other objects.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
StateProvinceId | The identifier for this entity as assigned by the state or province. | xs:normalizedString |
This is a common element used to designate the subject area of a course or other learning materials, or a department. It is used in SchoolCourseInfo and learning-related objects.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SubjectArea | This is a common element used to designate the subject area of a course or other learning materials, or a department. It is used in SchoolCourseInfo and learning-related objects. | |||
Code | M | The subject area code (i.e., the first two digits of the course classification code). | union of: SCEDSecondaryCoursesType SCEDNonSecondaryCoursesType | |
OtherCodeList | O | OtherCodeList |
A list of subject areas.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SubjectAreaList | A list of subject areas. | List | ||
SubjectArea | MR | Subject matter. | SubjectArea |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
TermSpan | ||||
Code | M | Code for session type. | NCES0266SessionTypeType | |
OtherCodeList | O | OtherCodeList |
Is the student in Title 1 programs?
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
Title1 | Is the student in Title 1 programs? | values:
|