Common and supporting types referenced in this specification are included here as a reference.
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 | |
| SIF_Metadata | O | SIF_Metadata | ||
| SIF_ExtendedElements | O | SIF_ExtendedElements |
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.
Figure A.5-1: FSAmountType| 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.
Figure A.6-1: FSCountType| 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.
Figure A.9-1: MonetaryAmountType| 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:
|
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:
|
| Element/@Attribute | Char | Description | Type | |
|---|---|---|---|---|
| RefIdType | An object or element identifier. | GUIDType |
SIF_ReportObject/ReportData, plus ReportPackage.Figure A.14-1: ReportDataObjectType| Element/@Attribute | Char | Description | Type | |
|---|---|---|---|---|
| ReportDataObjectType | The SIF objects that can be included in SIF_ReportObject/ReportData, plus ReportPackage. | choice of: ContactPersonal LAInfo LearnerAttendanceSummary LearnerContact LearnerExclusion LearnerGroupEnrolment LearnerPersonal LearnerSchoolEnrolment LearnerSpecialNeeds PersonPicture ReportAuthorityInfo ReportManifest SchoolGroup SchoolGroupType SchoolInfo SIF_AgentACL SIF_LogEntry SIF_ReportObject SIF_ZoneStatus TermInfo WorkforcePersonal ReportPackage |
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.
Figure A.15-1: ReportPackageType| 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 |
SIF_Event message.Figure A.16-1: SIF_EventObjectType| Element/@Attribute | Char | Description | Type | |
|---|---|---|---|---|
| SIF_EventObjectType | The SIF objects that can be included in a SIF_Event message. | choice of: ContactPersonal LAInfo LearnerAttendanceSummary LearnerContact LearnerExclusion LearnerGroupEnrolment LearnerPersonal LearnerSchoolEnrolment LearnerSpecialNeeds PersonPicture ReportAuthorityInfo ReportManifest SchoolGroup SchoolGroupType SchoolInfo SIF_AgentACL SIF_LogEntry SIF_ReportObject SIF_ZoneStatus TermInfo WorkforcePersonal |
SIF_Provide message.Figure A.17-1: SIF_ProvideObjectNamesTypeTable A.17-1: SIF_ProvideObjectNamesTypeSIF_Request message, or every SIF object name.Figure A.18-1: SIF_RequestObjectNamesTypeTable A.18-1: SIF_RequestObjectNamesTypeSIF_Response message.Figure A.19-1: SIF_ResponseObjectsTypeTable A.19-1: SIF_ResponseObjectsTypeSIF_Response message, or every SIF object.Figure A.20-1: SIF_ResponseObjectType| Element/@Attribute | Char | Description | Type | |
|---|---|---|---|---|
| SIF_ResponseObjectType | The SIF objects that can be included in a SIF_Response message, or every SIF object. | choice of: ContactPersonal LAInfo LearnerAttendanceSummary LearnerContact LearnerExclusion LearnerGroupEnrolment LearnerPersonal LearnerSchoolEnrolment LearnerSpecialNeeds PersonPicture ReportAuthorityInfo ReportManifest SchoolGroup SchoolGroupType SchoolInfo SIF_AgentACL SIF_LogEntry SIF_ReportObject SIF_ZoneStatus TermInfo WorkforcePersonal |
SIF_Subscribe message.Figure A.21-1: SIF_SubscribeObjectNamesTypeTable A.21-1: SIF_SubscribeObjectNamesType| 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
|