Common and supporting types referenced in this specification are included here as a reference.
AbstractContentPackageType
used as an element rather than an object, omitting RefId
, SIF_Metadata
and SIF_ExtendedElements
.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
AbstractContentElementType |
| |||
XMLData | C | Contains an arbitary XML element, encoded in UTF-8. | <xs:any processContents="lax" /> | |
@ | Description | O |
Contains an optional description of the content or a processing hint with regard to its structure (e.g. named standard, file layout or XSD).
Contents may be mandated in instances of this type, or types that follow the | xs:token |
TextData | C | Contains arbitrary text, encoded in UTF-8. | xs:string | |
@ | MIMEType | O |
Optional MIME type to specifically indicate the text type. Otherwise | xs:token |
@ | FileName | O | Optional file name to indicate the file from which the content originated, or to suggest a name to use when saving the content. | xs:token |
@ | Description | O |
Contains an optional description of the content or a processing hint with regard to its structure (e.g. named standard, file layout or XSD).
Contents may be mandated in instances of this type, or types that follow the | xs:token |
BinaryData | C | Contains the base64Binary encoding of binary or text data not encoded in UTF-8. | xs:base64Binary | |
@ | MIMEType | M | MIME type to indicate the content type. | xs:token |
@ | FileName | O | Optional file name to indicate the file from which the content originated, or to suggest a name to use when saving the content. | xs:token |
@ | Description | O |
Contains an optional description of the content or a processing hint with regard to its structure (e.g. named standard, file layout or XSD).
Contents may be mandated in instances of this type, or types that follow the | xs:token |
Reference | C | References external content via a URL. | ||
@ | MIMEType | M | MIME type to indicate the content type to be expected when retrieving the external content. | xs:token |
@ | Description | O |
Contains an optional description of the content or a processing hint with regard to its structure (e.g. named standard, file layout or XSD).
Contents may be mandated in instances of this type, or types that follow the | xs:token |
Reference/URL | M | Location of external content. | xs:anyURI |
An abstract type for derived content package types, elements and objects. This structure may be used verbatim, optionally extending
with additional attributes, or may be redefined to include only a subset of child elements and/or to add validation to XML
contained in XMLData
. Only one instance of XMLData
, TextData
, BinaryData
or
Reference
can occur in a single instance.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
AbstractContentPackageType |
An abstract type for derived content package types, elements and objects. This structure may be used verbatim, optionally extending
with additional attributes, or may be redefined to include only a subset of child elements and/or to add validation to XML
contained in | |||
@ | RefId | M | The GUID that uniquely identifies an instance of the package. | RefIdType |
XMLData | C | Contains an arbitary XML element, encoded in UTF-8. | <xs:any processContents="lax" /> | |
@ | Description | O |
Contains an optional description of the content or a processing hint with regard to its structure (e.g. named standard, file layout or XSD).
Contents may be mandated in instances of this type, or types that follow the | xs:token |
TextData | C | Contains arbitrary text, encoded in UTF-8. | xs:string | |
@ | MIMEType | O |
Optional MIME type to specifically indicate the text type. Otherwise | xs:token |
@ | FileName | O | Optional file name to indicate the file from which the content originated, or to suggest a name to use when saving the content. | xs:token |
@ | Description | O |
Contains an optional description of the content or a processing hint with regard to its structure (e.g. named standard, file layout or XSD).
Contents may be mandated in instances of this type, or types that follow the | xs:token |
BinaryData | C | Contains the base64Binary encoding of binary or text data not encoded in UTF-8. | xs:base64Binary | |
@ | MIMEType | M | MIME type to indicate the content type. | xs:token |
@ | FileName | O | Optional file name to indicate the file from which the content originated, or to suggest a name to use when saving the content. | xs:token |
@ | Description | O |
Contains an optional description of the content or a processing hint with regard to its structure (e.g. named standard, file layout or XSD).
Contents may be mandated in instances of this type, or types that follow the | xs:token |
Reference | C | References external content via a URL. | ||
@ | MIMEType | M | MIME type to indicate the content type to be expected when retrieving the external content. | xs:token |
@ | Description | O |
Contains an optional description of the content or a processing hint with regard to its structure (e.g. named standard, file layout or XSD).
Contents may be mandated in instances of this type, or types that follow the | xs:token |
Reference/URL | M | Location of external content. | xs:anyURI |
Base type, without attributes, for Name
elements, primarily to allow structure to be leveraged with different Type
attribute values.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
BaseNameType |
Base type, without attributes, for | |||
Prefix | O | A prefix associated with the name like Mr., Ms., etc. | xs:normalizedString | |
LastName | M | The last name. | LastName | |
FirstName | M | The first name. | FirstName | |
MiddleName | O | The middle name or initial. | MiddleName | |
Suffix | O | Generation of suffix like II, Jr., etc. | xs:normalizedString | |
PreferredName | O | This is a name that the person prefers to be called by. | xs:normalizedString | |
SortName | O | This is the name to be used for sorting purposes. | xs:normalizedString | |
FullName | O | A free text field for the complete name. | xs:normalizedString |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
DefinedProtocolsType | The transport protocols defined in SIF. | values:
|
This provides information about the value of a food service transaction amount. When credits are specified the value is the total cash value of all the credits.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
FSAmountType | MonetaryAmountType | |||
@ | Type | Type of amount. Note that when this common element is used not all of the following values apply. There are notes to indicate values that are applicable.
The type | values:
| |
@ | Credits |
Number of credits. This attribute does not apply to | xs:decimal |
Reports aggregate counts and, optionally, received funds for individual combinations of student or staff meal status and meal type.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
FSCountType | Reports aggregate counts and, optionally, received funds for individual combinations of student or staff meal status and meal type. | |||
MealStatus | C | Student meal status. If a meal status applies, either MealStatus (for students), or EarnedStatus (for staff) is specified. | MealStatus | |
EarnedStatus | C | Staff meal status. | EarnedStatus | |
MealType | O | MealType | ||
Amount | O | FSAmountType | ||
Tax | O | Value of tax collected. | MonetaryAmountType | |
Value | M | The value of the count. | xs:decimal |
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
GUIDType | SIF format for a GUID. | xs:token
|
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
IdRefType | A reference to a RefId. | RefIdType |
A monetary amount.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
MonetaryAmountType | A monetary amount. | xs:decimal | ||
@ | Currency | O | Currency code. Where omitted, defaults to implementation-defined local currency, typically USD in the United States. | ISO4217CurrencyNamesAndCodeElementsType |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
MsgIdType | A message identifier. | GUIDType |
Extends BaseNameType
to allow for one Type
attribute value, indicating the name is the name of record;
serves as the primary name in some SIF objects, including StudentPersonal
.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
NameOfRecordType |
Extends | BaseNameType | ||
@ | Type | M | Code that specifies what type of name this is. | values:
|
An unenumerated SIF object name.
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
ObjectNameType | An unenumerated SIF object name. | xs:NCName
|
A SIF XML object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
ObjectType | A SIF XML object. | <xs:sequence>
<xs:any processContents="lax" minOccurs="1" maxOccurs="unbounded" namespace="##any" />
</xs:sequence> |
Provides information about a student's relationship to an organization.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
OrganizationRelationshipType | Provides information about a student's relationship to an organization. | |||
ResidencyStatus | M | |||
ResidencyStatus/Code | M | Location of an individual's legal residence relative to (within or outside) the boundaries of the organization. | NCES0598PublicSchoolResidenceStatusType | |
ResidencyStatus/OtherCodeList | O | OtherCodeList | ||
ProvidingInstruction | M | Flag that indicates if the reporting organization is providing instruction to the student. | xs:boolean | |
ProvidingServices | M | Flag that indicates if the reporting organization is providing services that are not related to instruction to the student. An example of a non-instructional service is transportation. | xs:boolean | |
FinanciallyResponsible | M | Flag that indicates if the reporting organization is financially responsible for the student. | xs:boolean |
Extends BaseNameType
to allow for Type
attribute values excluding "name of record." Used for other names to
be included in addition to the name of record in objects like StudentPersonal.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
OtherNameType |
Extends | BaseNameType | ||
@ | Type | M | Code that specifies what type of name this is, excluding "name of record." | values:
|
A year, with an optional month/day, or an optional month by itself.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
PartialDateType | A year, with an optional month/day, or an optional month by itself. | union of: xs:date xs:gYearMonth xs:gYear |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
RefIdType | An object or element identifier. | GUIDType |
A SIF XML object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
ReportDataObjectType | A SIF XML object. | <xs:sequence>
<xs:any processContents="lax" minOccurs="0" maxOccurs="unbounded" />
</xs:sequence> |
AbstractContentPackageType
. ReportPackage
can be used in addition to SIF objects specifically in reporting situations within SIF_ReportObject
.
At this time, it is not a SIF object. It cannot be requested via SIF_Query
or SIF_ExtendedQuery
in a ReportManifest
. It may be included in SIF_ReportObject
as part of an external report
definition.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
ReportPackageType |
This package has exactly the same structure as AbstractContentPackageType . ReportPackage
can be used in addition to SIF objects specifically in reporting situations within SIF_ReportObject .
At this time, it is not a SIF object. It cannot be requested via SIF_Query or SIF_ExtendedQuery
in a ReportManifest . It may be included in SIF_ReportObject as part of an external report
definition.
| AbstractContentPackageType |
An unenumerated SIF object name.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
ServiceNameType | An unenumerated SIF object name. | xs:NCName |
Characteristics of the staff person identified by the district which the state uses to perform its matching logic.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
StaffParametersType | Characteristics of the staff person identified by the district which the state uses to perform its matching logic. | |||
StateProvinceId | O | Specified if the requesting agency believes it knows the person’s state Id. | StateProvinceId | |
LocalId | O | This is the requesting agent’s unique Id for the person. | LocalId | |
SIF_RefId | O | Requesting agency’s local zone’s GUID of the person’s data source object. | IdRefType | |
SSN | O | Social security number of the person. | SSN | |
Names | O | The name(s) of the person. | List | |
Names/Name | OR | The name(s) of the person. | Name | |
Addresses | O | The address(es) of the person. | List | |
Addresses/Address | OR | The address(es) of the person. | Address | |
Demographics | O | Demographic information about the person. This will typically be the core matching information. Privacy considerations may mean that it is filled differently here than it might be in a local object, but it must include enough to drive the state's matching algorithms. | Demographics | |
Contacts | O | Typically used to provide the state information about a person's parents and legal guardians. | List | |
Contacts/Contact | OR | Typically used to provide the state information about a person's parents and legal guardians. | ||
Contacts/Contact/Relationship | M | Relationship to the person. | Relationship | |
Contacts/Contact/Names | O | The name(s) of the contact. | List | |
Contacts/Contact/Names/Name | OR | The name(s) of the contact. | Name | |
Contacts/Contact/OtherIdList | O | OtherIds associated with the contact . | OtherIdList | |
Contacts/Contact/EducationalLevel | O | The highest level of education completed by the contact person. | EducationalLevel | |
EffectiveDate | O | This should match StudentSchoolEnrollment/EntryDate. | xs:date | |
StartDate | O | Start date for a range that is being requested. In most cases this will correspond to the school entry date. | xs:date | |
EndDate | O | End date for a range that is being requested. In most cases this will correspond to the school exit date. | xs:date | |
OtherIdList | O | Additional person identifiers not represented elsewhere in Characteristics (e.g. the driver's license number of the person ). | OtherIdList | |
TimeElement | O | SIF_Metadata’s TimeElement may be specified to indicate a time duration to which the characteristics apply (as opposed to adding new elements to Characteristics). This metadata may be supplied by systems that know a student existed in a district during a certain time period (e.g. a system initiating a student record exchange). If the responder is able to make use of the metadata, it may do so to narrow down the student look-up; otherwise the metadata can be ignored or logged. | TimeElement |
Characteristics of the student identified by the district which the state uses to perform its locator matching logic.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
StudentParametersType | Characteristics of the student identified by the district which the state uses to perform its locator matching logic. | |||
StateProvinceId | O | Specified if the requesting agency believes it knows the person’s state Id. | StateProvinceId | |
LocalId | O | This is the requesting agent’s unique Id for the person. | LocalId | |
SIF_RefId | O | Requesting agency’s local zone’s GUID of the student's data source object. | IdRefType | |
GradeLevel | O | The student’s current grade level. | GradeLevel | |
SSN | O | Social security number of the person. | SSN | |
Names | O | The name(s) of the person. | List | |
Names/Name | OR | The name(s) of the person. | Name | |
Addresses | O | The address(es) of the person. | List | |
Addresses/Address | OR | The address(es) of the person. | Address | |
Demographics | O | Demographic information about the person. This will typically be the core matching information. Privacy considerations may mean that it is filled differently here than it might be in a local object, but it must include enough to drive the state's matching algorithms. | Demographics | |
Contacts | O | Typically used to provide the state information about a person's parents and legal guardians. | List | |
Contacts/Contact | OR | Typically used to provide the state information about a person's parents and legal guardians. | ||
Contacts/Contact/Relationship | M | Relationship to the person. | Relationship | |
Contacts/Contact/Names | O | The name(s) of the contact. | List | |
Contacts/Contact/Names/Name | OR | The name(s) of the contact. | Name | |
Contacts/Contact/OtherIdList | O | OtherIds associated with the contact . | OtherIdList | |
Contacts/Contact/EducationalLevel | O | The highest level of education completed by the contact person. | EducationalLevel | |
EffectiveDate | O | This should match StudentSchoolEnrollment/EntryDate. | xs:date | |
StartDate | O | Start date for a range that is being requested. In most cases this will correspond to the school entry date. | xs:date | |
EndDate | O | End date for a range that is being requested. In most cases this will correspond to the school exit date. | xs:date | |
GraduationDate | O | Indicates the date the person's graduated Year, Year and Month, or Year, Month and Day may be specified. Intended to facilitate locating persons that may not be currently enrolled in a school or district, particularly in the context of locating student identifiers for initiating a request for a student's academic record. Supplied date values may often be approximations made by the entity endeavoring to request a student's academic record. | GraduationDate | |
SchoolAttendedName | O | The name of the school last attended by the person. | xs:normalizedString | |
SchoolAttendedLocation | O | The location of the school last attended by the person (e.g. city or county name, district name, etc.). | xs:normalizedString | |
OtherIdList | O | Additional person identifiers not represented elsewhere in Characteristics (e.g. the driver's license number of the person ). | OtherIdList | |
TimeElement | O | SIF_Metadata’s TimeElement may be specified to indicate a time duration to which the characteristics apply (as opposed to adding new elements to Characteristics). This metadata may be supplied by systems that know a student existed in a district during a certain time period (e.g. a system initiating a student record exchange). If the responder is able to make use of the metadata, it may do so to narrow down the student look-up; otherwise the metadata can be ignored or logged. | TimeElement |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
URIOrBinaryType | Allows for a URL or a Base-64 encoding. | union of: xs:anyURI xs:base64Binary |
Element/@Attribute | Char | Description | Type | |||||
---|---|---|---|---|---|---|---|---|
VersionType | A SIF version number. | xs:token
|
Element/@Attribute | Char | Description | Type | |||||
---|---|---|---|---|---|---|---|---|
VersionWithWildcardsType | A SIF version number, with wildcards for matching multiple versions. | xs:token
|