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 | |||
Title | O | A title or prefix associated with the name. If any of: Mr, Mrs, Ms, Miss, Rev, Fr, Dr, Prof, Hon, Sir, Lord, Lady - these must be as shown, otherwise free text. Note that title is not applicable to learners. | xs:normalizedString | |
FamilyName | C | Family name. That part of the person's name which is used to describe family, clan, tribal group, or marital association. Note that this element is required when known. However, it may not be possible to know the family name in which case you should add the available information to the FullName element. | xs:normalizedString | |
GivenName | C | Given name of the person. Note that this element is required if known. However, it may not be possible to know the given name in which case you should add the available information to the FullName element. | xs:normalizedString | |
MiddleName | O | All other given or middle names, each separated with a single space character. | xs:normalizedString | |
FamilyNameFirst | O | An indicator used to identify the naming conventions used by some predominantly non-European, ethnic or language groups and related to the display nature of a name. | AUCodeSetsYesOrNoCategoryType | |
PreferredFamilyName | O | The family name preferred most by the person (as written). | xs:normalizedString | |
PreferredFamilyNameFirst | O | An indicator used to identify the naming conventions used by some predominantly non-European, ethnic or language groups and related to the display nature of a name. | AUCodeSetsYesOrNoCategoryType | |
PreferredGivenName | O | The given name preferred most by the person (as written). | xs:normalizedString | |
Suffix | O | Textual suffix like PHD, JP, BSc. | xs:normalizedString | |
FullName | C | A free text field for the complete name for display purposes. If this is associated with a StudentPersonal,StaffPersonal or StudentContactPersonal record and the FamilyName and GivenName are not both specified, then this becomes mandatory. | xs:normalizedString |
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
DefinedProtocolsType | The transport protocols defined in SIF. | values:
|
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. Note that type “LGL” must be used here. | values:
|
An unenumerated SIF object name.
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
ObjectNameType | An unenumerated SIF object name. | xs:NCName
|
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.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
OtherNameType |
Extends | BaseNameType | ||
@ | Type | M | Code that specifies what type of name this is. Note that type “LGL” is NOT to be used here. | AUCodeSetsNameUsageTypeType |
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 |
SIF_ReportObject/ReportData
, plus ReportPackage
.Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
ReportDataObjectType | The SIF objects that can be included in SIF_ReportObject/ReportData , plus ReportPackage . | choice of: CalendarDate CalendarSummary Identity LEAInfo PersonPicture ReportAuthorityInfo ReportManifest RoomInfo SchoolCourseInfo SchoolInfo SchoolPrograms SessionInfo SIF_AgentACL SIF_LogEntry SIF_ReportObject SIF_ZoneStatus StaffAssignment StaffPersonal StudentActivityInfo StudentActivityParticipation StudentAttendanceSummary StudentContactPersonal StudentContactRelationship StudentDailyAttendance StudentParticipation StudentPeriodAttendance StudentPersonal StudentSchoolEnrollment StudentSDTN StudentSnapshot SummaryEnrollmentInfo TeachingGroup TermInfo TimeTable TimeTableCell TimeTableSubject 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.
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.SIF_Query/SIF_Example
.Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SIF_ExampleObjectType | The SIF objects that can be included in SIF_Query/SIF_Example . | EMPTY |
SIF_Provide
message.SIF_Request
message, or every SIF object name.SIF_Response
message.SIF_Response
message, or every SIF object.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: CalendarDate CalendarSummary Identity LEAInfo PersonPicture ReportAuthorityInfo ReportManifest RoomInfo SchoolCourseInfo SchoolInfo SchoolPrograms SessionInfo SIF_AgentACL SIF_LogEntry SIF_ReportObject SIF_ZoneStatus StaffAssignment StaffPersonal StudentActivityInfo StudentActivityParticipation StudentAttendanceSummary StudentContactPersonal StudentContactRelationship StudentDailyAttendance StudentParticipation StudentPeriodAttendance StudentPersonal StudentSchoolEnrollment StudentSDTN StudentSnapshot SummaryEnrollmentInfo TeachingGroup TermInfo TimeTable TimeTableCell TimeTableSubject |
SIF_Subscribe
message.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
|