Contains one of the SIF message types.
Contains one of the SIF message types.
Contains one of the SIF message types.
Contains one of the SIF message types.
Contains one of the SIF message types.
Contains one of the SIF message types.
Contains one of the SIF message types.
Contains one of the SIF message types.
Contains one of the SIF message types.
Contains one of the SIF message types.
Contains one of the SIF message types.
Contains one of the SIF message types.
Contains one of the SIF message types.
The version of the SIF Implementation Specification that defines this message's XML structure.
For this version of the specification, the value of this attribute is 2.0.
This attribute can be used by ZIS and agent implementations to choose schema files to
validate the message's XML.
Header information associated with a message.
SIF_MsgId is a globally unique message identifier from the Agent or ZIS that sends out the message.
Timestamp of when the message was sent.
The minimum level of authentication required by the message originator to be considered a secure channel upon message delivery to other agents.
The minimum level of encryption required by the message originator to be considered a secure channel upon message delivery to other agents.
The SIF_SourceId is the ID of the originator of the message. Each source needs to have a zone unique case-sensitive identifier.
This element represents the ID of the recipient of the message and may be present as follows:
Contains each SIF Context that applies to the message. If omitted, the applicable context is SIF_Default.
SIF_Context is repeatable for SIF_Events, not repeatable for SIF_Request or SIF_Response.
The minimum level of encryption required by the message originator to be considered a secure channel upon message delivery to other agents.
The minimum level of encryption required by the message originator to be considered a secure channel upon message delivery to other agents.
No encryption required
Symmetric key length of at least 40 bits is to be used
Symmetric key length of at least 56 bits is to be used
Symmetric key length of at least 80 bits is to be used
Symmetric key length of at least 128 bits is to be used
The minimum level of authentication required by the message originator to be considered a secure channel upon message delivery to other agents.
The minimum level of authentication required by the message originator to be considered a secure channel upon message delivery to other agents.
No authentication required and a valid certificate does not need to be presented.
A valid certificate must be presented.
A valid certificate from a trusted certificate
authority must be presented.
A valid certificate from a trusted certificate
authority must be presented and the CN field of the certificate's
Subject entry must match the host sending the certificate.
A list of SIF contexts that applies to a message or operation. Typically where used as an optional element,
the omission of this element implies the SIF_Default context applies.
The name of a SIF Context that applies to a message or operation.
The name of a SIF Context that applies to a message or operation.
Contains protocol information for contacting a ZIS or Agent.
This element is required if the protocol is HTTPS or HTTP.
It contains the https or http URL for contacting the agent.
Property name.
Property value.
The type of protocol to use (HTTPS, HTTP or an implementation-defined protocol).
The type of protocol to use (HTTPS, HTTP or an implementation-defined protocol).
The type of protocol to use (HTTPS, HTTP or an implementation-defined protocol).
Whether the protocol provides a secure channel.
This element is used to signal a successful response.
An optional textual description/equivalent of SIF_Code.
Optional element to hold data related to a successful operation. This data is currently limited
to a SIF_Message returned by the ZIS in response to a Pull-Mode Agent's SIF_GetMessage,
SIF_AgentACL returned by the ZIS in response to SIF_Register and SIF_GetAgentACL,
and SIF_ZoneStatus returned by the ZIS in response to SIF_GetZoneStatus.
Optional element to hold data related to a successful operation. This data is currently limited
to a SIF_Message returned by the ZIS in response to a Pull-Mode Agent's SIF_GetMessage,
SIF_AgentACL returned by the ZIS in response to SIF_Register and SIF_GetAgentACL,
and SIF_ZoneStatus returned by the ZIS in response to SIF_GetZoneStatus.
Optional element to hold data related to a successful operation. This data is currently limited
to a SIF_Message returned by the ZIS in response to a Pull-Mode Agent's SIF_GetMessage,
SIF_AgentACL returned by the ZIS in response to SIF_Register and SIF_GetAgentACL,
and SIF_ZoneStatus returned by the ZIS in response to SIF_GetZoneStatus.
Optional element to hold data related to a successful operation. This data is currently limited
to a SIF_Message returned by the ZIS in response to a Pull-Mode Agent's SIF_GetMessage,
SIF_AgentACL returned by the ZIS in response to SIF_Register and SIF_GetAgentACL,
and SIF_ZoneStatus returned by the ZIS in response to SIF_GetZoneStatus.
This element is used to signal an unsuccessful response.
See Error Codes.
See Error Codes.
See Error Codes.
See Error Codes.
See Error Codes.
See Error Codes.
See Error Codes.
See Error Codes.
See Error Codes.
See Error Codes.
See Error Codes.
See Error Codes.
See Error Codes.
See Error Codes.
A simple, easy to understand, description of the error. The primary consumer of this message is the application user. Example: "Unable to open database."
An optional error description that is more complete and technical in nature. It is to be used as a diagnostic message in trouble-shooting procedures. Example: "The 'Students' table is opened in exclusive mode by user 'ADM1' (dbm.cpp, line 300)."
SIF's default query mechanism.
Individual elements/attributes being requested of matching object. See SIF_Element Syntax below.
If specified, only the elements/attributes requested are returned in the SIF_Response (with any parent elements/attributes);
otherwise, all elements supported by the provider's object are returned.
The actual name of the object that is being queried for.
This is the element/attribute being queried. See below for syntax.
The comparison operator for the condition.
Equals
Less Than
Greater Than
Less Than Or Equals
Greater Than Or Equals
Not Equals
SIF_Value is the data that is used to compare with the value of the element or attribute.
The boolean operator for joining conditions (SIF_Condition elements) within this element. Note that None should be used if there
is only one SIF_Condition element.
The Boolean operator for joining conditions (SIF_Conditions elements) within this element. Note that None should be used if there is only one
SIF_Conditions element.
An example SIF object that serves as a template for matching objects. There is an implied EQ operator
for every element/attribute value present and an implied And group of all resulting conditions. Currently
this is an experimental feature and limited to use with StudentLocator; wider use may be considered in future
versions of this specification.
An example SIF object that serves as a template for matching objects. There is an implied EQ operator
for every element/attribute value present and an implied And group of all resulting conditions. Currently
this is an experimental feature and limited to use with StudentLocator; wider use may be considered in future
versions of this specification.
SIF's default query mechanism for SIF_Request, SIF_Query, has several limitations that limit its usefulness when creating reporting applications
that process data from a SIF zone. SIF_Query is limited to matching only one object type per query, requiring applications to
manually join together results as needed for reporting and general data processing. SIF_ExtendedQuery is designed to allow for joins on
object identifiers/RefIds and to allow retrieval of data in a row/column fashion similar to SQL. Each returned column may contain hierarchical XML elements/objects.
While envisioned as the primary mechanism for SIF-based ReportManifests, Providers and Responders in a Zone may support SIF_ExtendedQuery
in addition to SIF_Query. Support for SIF_ExtendedQuery can be declared in and retrieved from the Zone is various Infrastructure
messages and objects.
If no SIF_DestinationId applies to the request and this element is supplied, the Requester specifies that the
extended query be routed to the Provider on record for the given object name. If this element is omitted and no SIF_DestinationId
applies to the request, the ZIS routes the request to the Provider on record for the object name in SIF_From.
Indicates the element/attribute to return as a column. Contents can be left empty to return the whole object specified in ObjectName,
or * can be designated to return all attributes and immediate child elements of the object specified in ObjectName, or
SIF_Element Syntax can be specified, relative to the object specified in ObjectName. Requested attributes
are to be returned as the text value of the corresponding attribute, elements as a copy of the XML element itself including attributes if they exist.
Optional caption for the column.
The name of the object from which to retrieve element/attributes.
Specifies whether query results should return all rows (false) or just distinct ones (true). Rows are distinct if
at least one column differs between them.
The maximum number of rows to return. If All, return all rows, otherwise return the top rows up to the maximum
row count indicated.
The maximum number of rows to return. If All, return all rows, otherwise return the top rows up to the maximum
row count indicated.
The maximum number of rows to return. If All, return all rows, otherwise return the top rows up to the maximum
row count indicated.
Specifies the left-side element/attribute on which to constrain the join. Currently only support for keys/RefIds/RefId references is required.
Name of the object that contains the element/attribute.
Specifies right left-side element/attribute on which to constrain the join. Currently only support for keys/RefIds/RefId references is required.
Name of the object that contains the element/attribute.
Type of relational join.
The name of the object to query.
This is the element/attribute being queried.
The comparison operator for the condition.
Equals
Less Than
Greater Than
Less Than Or Equals
Greater Than Or Equals
Not Equals
SIF_Value is the data that is used to compare with the value of the element or attribute.
The boolean operator for joining conditions (SIF_Condition elements) within this element. Note that None should be used if there
is only one SIF_Condition element.
The Boolean operator for joining conditions (SIF_Conditions elements) within this element. Note that None should be used if there is only one
SIF_Conditions element.
Indicates the element/attribute by which to sort.
The name of the object containing the element/attribute.
Whether to order the element/attribute in ascending or descending order.
This element provides a wrapper for data returned in response to a SIF_ExtendedQuery. Used in SIF_Response
and SIF_ReportObject.
The element/attribute specified for the column in SIF_ExtendedQuery.
The object in which the element/attribute occurs.
The caption for the column, if specified in SIF_ExtendedQuery.
Contains the value of each column specified in SIF_ExtendedQuery/SIF_Select.
The order of the columns must correspond to the order of the elements as requested in SIF_ExtendedQuery.
Note the number of columns may be expanded from the requested columns if * is indicated
one or more times in the SIF_Select clause.
This message is used as an acknowledgement to an infrastructure message.
Header information associated with this message.
The SIF_SourceId of the infrastructure message for which the SIF_Ack serves as a response.
The SIF_MsgId of the infrastructure message for which the SIF_Ack message serves as a response.
This element is used to signal a successful response.
This element is used to signal an unsuccessful response.
SIF_Event is used to deliver event objects as defined in SIF.
Header information associated with this message.
Contains the actual object (partial or whole) that is being added, changed or deleted.
This is the name of the object being added, changed or deleted.
This is the action associated with the object that is being conveyed by this SIF_Event.
The SIF_Provide message is used for advertising the provision of data objects.
Header information associated with this message.
Whether or not the Agent supports SIF_ExtendedQuery for this object.
The contexts in which the object is being provided; if omitted, the context is SIF_Default.
The actual name of the object that is being provided.
Once registered, this message allows an agent to announce to the ZIS the functionality the agent will provide.
The ZIS compares the functionality to its access control list and either returns a failure or a success. Upon success,
the ZIS performs an atomic update of its provide/subscribe database entries for the agent to match the objects listed in this message and atomically
updates other stored settings for the agent.
A ZIS must not allow an agent to perform operations that it did not successfully announce. Agents should be aware that if the access control
list changes after a successful SIF_Provision, some operations may still be rejected with access control errors.
Header information associated with this message.
Whether or not SIF_ExtendedQuery is supported with regard to this object.
Applicable contexts for stated object support. If omitted, the context defaults to SIF_Default.
The name of each object.
Applicable contexts for stated object support. If omitted, the context defaults to SIF_Default.
The name of each object.
Applicable contexts for stated object support. If omitted, the context defaults to SIF_Default.
The name of each object.
Applicable contexts for stated object support. If omitted, the context defaults to SIF_Default.
The name of each object.
Applicable contexts for stated object support. If omitted, the context defaults to SIF_Default.
The name of each object.
Optionally specify whether or not SIF_ExtendedQuery may be sent in requests for this object.
Applicable contexts for stated object support. If omitted, the context defaults to SIF_Default.
The name of each object.
Whether or not SIF_ExtendedQuery is supported with regard to this object.
Applicable contexts for stated object support. If omitted, the context defaults to SIF_Default.
The name of each object.
SIF_Register is the message for registering an agent with a ZIS.
Header information associated with this message.
This is the descriptive name of the agent that is registering (i.e. Ramsey Media Center).
Specifies which SIF Specification version(s) the agent supports. If the ZIS cannot communicate in this format, it should reject the request.
Specifies the maximum size of a packet to be returned by the ZIS. The ZIS may return packets smaller than, or equal to, the maximum value.
Specifies the communication mode (Pull or Push) as chosen by the message sender.
If SIF_Mode is Push, SIF_Protocol contains protocol information for contacting the agent in Push mode. A Pull-mode agent does not need to send SIF_Protocol; if received, a ZIS ignores it.
The vendor of the SIF agent.
The agent version number. The format of this field is undefined, but it should
match the format used in the agent's conformance statement, if the agent is SIF Certified.
The name of the company of the product that this agent supports.
The name of the product that this agent supports.
The version of the product. This field is informative only.
HTTP URL referencing an icon for graphical representation of the application/agent.
Should range from 16x16 pixels to 128x128 pixels and be of an image MIME type commonly supported by Web browsers (e.g. PNG, JPEG, GIF).
Agents may optionally follow the more restrictive guidelines at [FAVICON].
SIF_Request is used to request information in SIF data objects from other SIF nodes.
Header information associated with this message.
Specifies which SIF Specification version should be used when returning the response data; wildcards are allowed.
The responding agent SHOULD return data using the highest version it supports
that falls within the specified versions.
Specifies the maximum size of a response packet to be returned to the requester.
The responder may return packets smaller than, or equal to, the maximum value.
To guarantee delivery of response packets, requesting agents must not specify a SIF_MaxBufferSize greater than its registered SIF_Register/SIF_MaxBufferSize.
Either SIF_Query or SIF_ExtendedQuery must be specified, which contain the criteria to be used to match response objects.
SIF_Response is used to respond to a SIF_Request message.
Header information associated with this message. The SIF_DestinationId needs to be the SIF_SourceId of the original SIF_Request message being processed.
This is the message ID of the SIF_Request message being processed. It provides a unique match between a SIF_Response and a previous SIF_Request. Since the ID of each message from an agent is unique, the receiver of a SIF_Response message will be able to relate the SIF_Response to a SIF_Request that it sent out previously.
This element represents the index of the SIF_Response message in the sequence of packets that make up a complete response. Its value must be in the range of 1 through n, with n equal to the total number of packets that make up a response.
This element provides an indication as to whether there are more packets besides this one to make up a complete response.
The responder returns SIF_Error, SIF_ObjectData or SIF_ExtendedQueryResults.
The SIF_ObjectData element contains the data objects matching the supplied criteria in the SIF_Request message if the
SIF_Request contained SIF_Query. If the SIF_Request contained SIF_ExtendedQuery, include SIF_ExtendedQueryResults.
This element contains the elements requested by SIF_ExtendedQuery in SIF_Request.
This message is used to subscribe to event objects that are contained in this message.
Header information associated with this message.
The contexts to which the subscription applies; if omitted, the context is SIF_Default.
The actual name of the object that is being subscribed to. All valid SIF_Events for this object will be routed to the subscriber.
This message is designed to control the flow of data an agent and ZIS or vice-versa, and to synchronously
retrieve data available from the ZIS.
Header information associated with this message.
This element holds the sub-message being sent.
This element holds the sub-message being sent.
This element holds the sub-message being sent.
This element holds the sub-message being sent.
This element holds the sub-message being sent.
This element holds the sub-message being sent.
This element holds the sub-message being sent.
This sub-message detects if an a Push-Mode Agent or ZIS is ready to receive and process messages.
This sub-message tells a receiver not to send any more messages to the sender.
This message tells a receiver that the sender is able to process messages.
This message tells the ZIS to return the first available message to the agent, subject to Selective Message Blocking.
This message tells the ZIS to return the current SIF_ZoneStatus in a SIF_Ack.
This message tells the ZIS to return the Agent's ACL permissions in a SIF_Ack.
This message performs the opposite function of SIF_Provide.
Header information associated with this message.
The contexts from which the object is being removed; if omitted, the context is SIF_Default.
The actual name of the object that is being removed.
This message is used to unregister an agent from a Zone.
Header information contained in the message.
This message is used to unsubscribe to SIF_Events.
Header information associated with this message.
The applicable contexts; if omitted, the context is SIF_Default.
The actual name of the object from which the agent should be unsubscribed. Events pertaining to this object published after successful unsubscription will no longer be queued for delivery to the agent. Events already queued for delivery to the agent prior to unsubscription will be delivered.
The SIF_ZoneStatus object is an object that is implicitly provided by all Zone Integration Servers to provide
information about the ZIS. Zone Integration Servers MUST provide this object.
The descriptive name for the zone.
HTTP URL referencing an icon for graphical representation of the ZIS/Zone.
Should range from 16x16 pixels to 128x128 pixels and be of an image MIME type commonly supported by Web browsers (e.g. PNG, JPEG, GIF).
Agents may optionally follow the more restrictive guidelines at [FAVICON].
The name of the company that wrote the ZIS.
The product name assigned by the vendor to identify this ZIS.
The version of the vendor's product—not necessarily the SIF version.
The name of the object being provided by this SIF node.
The identifier of the SIF node that is providing objects. This is the agent or ZIS identifier that would appear in the SIF_SourceId field of any SIF_Header created by the SIF node.
The name of the object being subscribed to by this SIF node.
The identifier of the SIF node that is subscribing to the object events. This is the agent or ZIS identifier that would appear in the SIF_SourceId field of any SIF_Header created by the SIF node.
The name of the object being published by this agent.
The identifier of the SIF node that can publish the SIF_Event. This is the agent identifier that would appear in the SIF_SourceId field of any SIF_Header created by the agent.
The name of the object being published by this agent.
The identifier of the SIF node that can publish the SIF_Event. This is the agent identifier that would appear in the SIF_SourceId field of any SIF_Header created by the agent.
The name of the object being published by this agent.
The identifier of the SIF node that can publish the SIF_Event. This is the agent identifier that would appear in the SIF_SourceId field of any SIF_Header created by the agent.
The identifier of the SIF node that can respond. This is the agent identifier that would appear in the SIF_SourceId field of any SIF_Header created by the agent.
The name of the object being requested by this agent.
The identifier of the SIF node that can request an object. This is the agent identifier that would appear in the SIF_SourceId field of any SIF_Header created by the agent.
The descriptive name of the SIF node (i.e. Ramsey Food Services).
HTTP URL referencing an icon for graphical representation of the application/agent.
Should range from 16x16 pixels to 128x128 pixels and be of an image MIME type commonly supported by Web browsers (e.g. PNG, JPEG, GIF).
Agents may optionally follow the more restrictive guidelines at [FAVICON].
The vendor of the SIF agent.
The agent version number. The format of this field is undefined, but it should
match the format used in the agent's conformance statement, if the agent is SIF Certified.
The name of the company of the product that this agent supports.
The name of the product that this agent supports.
The version of the product. This field is informative only.
The agent or ZIS identifier. This is the same value that the SIF node would place in any SIF_Header that it would create.
Specifies the communication mode (Pull or Push) as chosen by the message sender.
Describes the currently active protocol that the SIF node is using to communicate with the ZIS.
This is the version or versions of the SIF Specification that the SIF node uses. For agents, this information was communicated when the SIF node registered with the ZIS.
This is the level of authentication that the SIF node supports when it wants to communicate via a secure channel.
This is the level of encryption that the SIF node supports when it wants to communicate via a secure channel.
Specifies that the ZIS should never send packets larger than this value. Query responses from other providers are controlled by the SIF_MaxBufferSize attribute in the SIF_Request message.
This element shows whether the SIF node is ready to process messages.
The SIF node is ready to process messages
The SIF node is sleeping and cannot process messages
The type of the node registered with the ZIS. Note that ZIS is forward-looking and not used currently; all information about this
Zone/ZIS is contained outside SIF_SIFNodes.
Describes a particular authentication protocol supported.
Lists a specific SIF Implementation Specification version.
Should a ZIS vendor provide an administration interface for the zone via a URL, the ZIS can make the URL available in SIF_ZoneStatus. Agent administrators can use the URL to access zone administration features, should they have permission to do so.
The identifier for this Zone.
It is the same as the SIF_SourceId that the ZIS would place in any SIF_Header that it creates.
The SIF_ZoneStatus object is an object that is implicitly provided by all Zone Integration Servers to provide
information about the ZIS. Zone Integration Servers MUST provide this object.
The descriptive name for the zone.
HTTP URL referencing an icon for graphical representation of the ZIS/Zone.
Should range from 16x16 pixels to 128x128 pixels and be of an image MIME type commonly supported by Web browsers (e.g. PNG, JPEG, GIF).
Agents may optionally follow the more restrictive guidelines at [FAVICON].
The name of the company that wrote the ZIS.
The product name assigned by the vendor to identify this ZIS.
The version of the vendor's product—not necessarily the SIF version.
The name of the object being provided by this SIF node.
The identifier of the SIF node that is providing objects. This is the agent or ZIS identifier that would appear in the SIF_SourceId field of any SIF_Header created by the SIF node.
The name of the object being subscribed to by this SIF node.
The identifier of the SIF node that is subscribing to the object events. This is the agent or ZIS identifier that would appear in the SIF_SourceId field of any SIF_Header created by the SIF node.
The name of the object being published by this agent.
The identifier of the SIF node that can publish the SIF_Event. This is the agent identifier that would appear in the SIF_SourceId field of any SIF_Header created by the agent.
The name of the object being published by this agent.
The identifier of the SIF node that can publish the SIF_Event. This is the agent identifier that would appear in the SIF_SourceId field of any SIF_Header created by the agent.
The name of the object being published by this agent.
The identifier of the SIF node that can publish the SIF_Event. This is the agent identifier that would appear in the SIF_SourceId field of any SIF_Header created by the agent.
The identifier of the SIF node that can respond. This is the agent identifier that would appear in the SIF_SourceId field of any SIF_Header created by the agent.
The name of the object being requested by this agent.
The identifier of the SIF node that can request an object. This is the agent identifier that would appear in the SIF_SourceId field of any SIF_Header created by the agent.
The descriptive name of the SIF node (i.e. Ramsey Food Services).
HTTP URL referencing an icon for graphical representation of the application/agent.
Should range from 16x16 pixels to 128x128 pixels and be of an image MIME type commonly supported by Web browsers (e.g. PNG, JPEG, GIF).
Agents may optionally follow the more restrictive guidelines at [FAVICON].
The vendor of the SIF agent.
The agent version number. The format of this field is undefined, but it should
match the format used in the agent's conformance statement, if the agent is SIF Certified.
The name of the company of the product that this agent supports.
The name of the product that this agent supports.
The version of the product. This field is informative only.
The agent or ZIS identifier. This is the same value that the SIF node would place in any SIF_Header that it would create.
Specifies the communication mode (Pull or Push) as chosen by the message sender.
Describes the currently active protocol that the SIF node is using to communicate with the ZIS.
This is the version or versions of the SIF Specification that the SIF node uses. For agents, this information was communicated when the SIF node registered with the ZIS.
This is the level of authentication that the SIF node supports when it wants to communicate via a secure channel.
This is the level of encryption that the SIF node supports when it wants to communicate via a secure channel.
Specifies that the ZIS should never send packets larger than this value. Query responses from other providers are controlled by the SIF_MaxBufferSize attribute in the SIF_Request message.
This element shows whether the SIF node is ready to process messages.
The SIF node is ready to process messages
The SIF node is sleeping and cannot process messages
The type of the node registered with the ZIS. Note that ZIS is forward-looking and not used currently; all information about this
Zone/ZIS is contained outside SIF_SIFNodes.
Describes a particular authentication protocol supported.
Lists a specific SIF Implementation Specification version.
Should a ZIS vendor provide an administration interface for the zone via a URL, the ZIS can make the URL available in SIF_ZoneStatus. Agent administrators can use the URL to access zone administration features, should they have permission to do so.
The identifier for this Zone.
It is the same as the SIF_SourceId that the ZIS would place in any SIF_Header that it creates.
This object provides an Agent its access control list (ACL) settings in the Zone.
List of contexts in which rights for the given action/object apply.
The name of each object.
List of contexts in which rights for the given action/object apply.
The name of each object.
List of contexts in which rights for the given action/object apply.
The name of each object.
List of contexts in which rights for the given action/object apply.
The name of each object.
List of contexts in which rights for the given action/object apply.
The name of each object.
List of contexts in which rights for the given action/object apply.
The name of each object.
List of contexts in which rights for the given action/object apply.
The name of each object.
This object provides an Agent its access control list (ACL) settings in the Zone.
List of contexts in which rights for the given action/object apply.
The name of each object.
List of contexts in which rights for the given action/object apply.
The name of each object.
List of contexts in which rights for the given action/object apply.
The name of each object.
List of contexts in which rights for the given action/object apply.
The name of each object.
List of contexts in which rights for the given action/object apply.
The name of each object.
List of contexts in which rights for the given action/object apply.
The name of each object.
List of contexts in which rights for the given action/object apply.
The name of each object.
Previous, alternate or other names or aliases associated with a person.
Name of the person. Note: Type value of 04 may not occur here.
In a Change event, this flag can be used to indicate an element has been deleted from the parent list container.
At a minimum the key for the list must also be present.
The student's planned level of participation in statewide assessments.
Identifies source of value provided.
e.g. district-specific
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 Primary.
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 Primary.
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 Primary.
Other (not valid for special education)
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.
Identifies relative severity of disability - only one can be primary
Identifies relative severity of disability - only one can be secondary
Identifies relative severity of disability - only one can be tertiary
Multiple disabilities can be identified as "Additional"
The current status of the student's program participation.
Referred
Eligible
Not Eligible
Active
Exited
Other
Identifies the individualized program for which the student's participation is described in this instance.
Identifies the individualized program for which the student's participation is described in this instance.
Identifies the individualized program for which the student's participation is described in this instance.
Identifies the individualized program for which the student's participation is described in this instance.
Supplemental education services
Early intervening services
Individual learning / graduation plan
Exchange program - foreign student attending district school
Exchange program - district student attending foreign school
Home schooling
Early childhood full-day program for 3-year-old students
Early childhood full-day program for 4-year-old students
Early childhood half-day program for 3-year-old students
Early childhood half-day program for 4-year-old students
Kindergarten full-day program
Kindergarten half-day program
Neglected and Delinquent (ESEA I-D)
Reading First (Title I-B-1 and I-B-2)
Education for homeless children and youths (MVHAA Title VII-B)
Rural education (ESEA VI-B)
Does the state require that the course be completed for graduation?
Does the state require that the course be completed for graduation?
A list of subject areas.
Subject matter.
Code for session type.
A list of contact persons associated with a school.
Indicates whether or not this school contact's information should be published in a directory of school information.
URL for a school.
URL for a school.
Name of Local Education Agency.
Name of Local Education Agency.
A person's last name.
A person's last name.
A person's first name.
A person's first name.
A person's middle name or initial.
A person's middle name or initial.
Social Security Number
Social Security Number
Is the student IDEA-eligible ("special education")? (Mutually exclusive with Section 504 classification.)
Is the student IDEA-eligible ("special education")? (Mutually exclusive with Section 504 classification.)
Is this a migrant student?
Is this a migrant student?
Is the student in Title 1 programs?
Is the student in Title 1 programs?
Is the student in Gifted/Talented programs?
Is the student in Gifted/Talented programs?
Does the student meet the State criteria for classification as having an economic disadvantage?
Does the student meet the State criteria for classification as having an economic disadvantage?
Is the student an English Language Learner under Title 3?
Is the student an English Language Learner under Title 3?
Is the student homeless?
Is the student homeless?
Is the student a qualified individual under Section 504 of the Rehabilitation Act? (Mututally exclusive with IDEA classification.)
Is the student a qualified individual under Section 504 of the Rehabilitation Act? (Mututally exclusive with IDEA classification.)
Does the student meet the State criteria for classification as a vocational concentrator?
Does the student meet the State criteria for classification as a vocational concentrator?
Does the student meet the State criteria for classification as being an immigrant?
Does the student meet the State criteria for classification as being an immigrant?
Is the student participating in programs for neglected, delinquent, or at risk children?
Is the student participating in programs for neglected, delinquent, or at risk children?
School-defined local code for a course.
School-defined local code for a course.
State-defined standard course code used to report information about courses.
State-defined standard course code used to report information about courses.
A district course code.
A district course code.
Title of a course.
Title of a course.
Other identification information associated with a school or LEA.
Other identification information associated with a school or LEA.
Code indicating which identification system is used.
The number of credits awarded upon course completion.
The type of credit offered.
An indication of the general nature and difficulty of instruction provided.
Code representing the general nature and difficulty of instruction provided.
A list of Address elements.
In a Change event, this flag can be used to indicate an element has been deleted from the parent list container. At a minimum the key for the list must also be present.
This element contains address data.
Address line 1.
Address line 2.
Address line 3.
Name of the complex.
The address number assigned to the building.
Street prefix like NE
The name of the street.
The type of street. For example, Lane, Blvd., Ave., etc.
Street suffix like SW.
Type of apartment, for example, Suite.
Apartment number prefix.
The number of the apartment.
Apartment number suffix.
The city part of the address.
The county part of the address.
The state or province code.
The country code.
The ZIP/postal code.
The location of the address.
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.
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.
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.
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.
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.
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.
A country code.
A country code.
A country code.
A country code.
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.
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.
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.
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.
Common element used to supply information for a contact person at a school, LEA, or other institution.
A prefix associated with the name like Mr., Ms., etc.
The last name.
The first name.
The middle name or initial.
Generation of suffix like II, Jr., etc.
This is a name that the person prefers to be called by.
This is the name to be used for sorting purposes.
A free text field for the complete name. Mandatory if LastName and FirstName are omitted.
Code that specifies what type of name this is. If unsure, use 04.
Given Name (Name at Birth)
Current Legal
Alias
Name of Record
Previous Name (sometimes called Maiden Name of Female Persons)
Married Name
Professional Name
The contact person's position title.
Role played by this contact in this instance.
Address of the contact.
List of Email elements.
List of PhoneNumber elements.
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.
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.
The general racial category which reflects the individual's recognition of his or her community or with which the individual most identifies.
A percentage associated with the race.
A person's gender.
A person's gender.
Male
Female
Unknown
A person's date of birth.
A person's date of birth.
Demographics information about the student, contact, staff member, etc. This element occurs within objects such as
StudentPersonal, StudentContact, etc.
Person's gender.
The person's date of birth.
Means by which the person's birth date was validated.
The person's place of birth—like village, town, city etc.
The county in which the person was born.
The person's state of birth.
The person's country of birth.
A person's country of citizenship.
A person's country of residence.
Date the person first arrived in the country.
The person's citizenship status.
Person's proficiency in English.
The code representing the specific language that an individual uses to communicate.Â
An indication of the function and context in which an individual uses a language to communicate.
Specific dialect of a person's language.
Code representing the setting/environment in which the person resides
The person's marital status.
A code representing the highest level of education completed by a person.
A code representing the highest level of education completed by a person.
A list of electronic identifiers associated with an entity.
Common element used to specify entity identifiers that are read by electronic equipment. It is used in objects such
as StudentPersonal, StaffPersonal, and LibraryPatronStatus.
Electronic ID type.
A list of e-mail addresses associated with an individual.
In a Change event, this flag can be used to indicate an element has been deleted from the parent list container. At a minimum the key for the list must also be present.
This element represents an e-mail address of one of a number of types and occurs in objects such as
StudentPersonal, StaffPersonal, StudentContact, etc.
This attribute specifies the type of e-mail address.
The first date on which a student enters.
The first date on which a student enters.
The date on which a student exits.
The date on which a student exits.
Grade or academic level.
Code representing the grade level.
Pre-Kindergarten/Preschool
Kindergarten
Postgraduate/Adult
Ungraded
This is a common element used to specify a collection of grade levels supported. It is used in SchoolInfo and
assessment-related objects.
Date student officially graduated from secondary education.
Year of graduation (CCYY).
Month of graduation (MM).
Day of graduation (DD).
Currently projected graduation year (CCYY).
Currently projected graduation year (CCYY).
First projected graduation year, usually determined when student is accepted into 9th grade (CCYY).
First projected graduation year, usually determined when student is accepted into 9th grade (CCYY).
This element contains a map location. The GridLocation element is utilized within other objects and elements, such
as BusStopInfo and Address, etc.
Latitude in decimal degrees.
Longitude in decimal degrees.
Common element used to specify the locally-defined number or identifier for a homeroom. It is used in objects such
as RoomInfo and StudentSnapshot.
Common element used to specify the locally-defined number or identifier for a homeroom. It is used in objects such
as RoomInfo and StudentSnapshot.
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.
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.
This element represents the meeting times and periods for a course, and occurs within objects such as SectionInfo
and StudentSectionEnrollment.
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").
The period within the day when this section takes place (e.g., "0" through "7").
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.
Code that specifies what type of name this is. If unsure, use 04.
Given Name (Name at Birth)
Current Legal
Alias
Name of Record
Previous Name (sometimes called Maiden Name of Female Persons)
Married Name
Professional Name
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.
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.
Operational condition of an institution.
Operational condition of an institution.
Operational condition of an institution.
Operational condition of an institution.
An "other" identifier associated with a person. This element occurs in objects such as StudentPersonal and
StaffPersonal, etc.
Code that defines the type of this other ID. Note: A subset of valid values may be specified in data objects.
Lists phone numbers associated with an entity.
In a Change event, this flag can be used to indicate an element has been deleted from the parent list container. At a minimum the key for the list must also be present.
This element represents a phone number and occurs within objects such as StudentPersonal, StaffPersonal, etc.
Phone number. Free-form, but typical U.S. formats include:
Phone number extension.
Indicates whether or not the phone number is available to the public.
Code that specifies what type of phone number this is. Note: A subset of valid values may be specified in data objects.
Program value.
The type of the program. Type identifies the list of values.
Code from the NCES Handbook
Code defined by the State Department of Education
Locally-defined code
Textual description
Indicates whether or not information should be published in a directory.
Indicates whether or not information should be published in a directory.
Code that defines the relationship of one person to another.
Code representing the relationship.
The name of the school.
The name of the school.
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).
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).
Allows an agent to include data not yet defined within a SIF data object as name/value pairs.
A name/value pair, the name being contained in the Name attribute, the value being the element content.
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.
In a Change event, this flag can be used to indicate an element has been deleted from the parent list container. At a minimum the key for the list must also be present.
Course code from the School Codes for the Exchange of Data that describe the content of the course.
Five-digit number. Subject areas are represented by the first two digits, the last three digits specify a particular course within the subject area.
Conveys the level of the course.
Basic or remedial
General or regular
Enriched or advanced
Honors
Identifies the amount of credit available to a student who successfully meets the objectives of the course, measured in Carnegie units (9.99 format).
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.
One-digit number representing the total number of courses in the consecutive sequence described by the same general course description.
The identifier for this entity as assigned by the state or province.
The identifier for this entity as assigned by the state or province.
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.
The subject area code (i.e., the first two digits of the course classification code).
The subject area code (i.e., the first two digits of the course classification code).
The subject area code (i.e., the first two digits of the course classification code).
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 OtherCodes are supported, both Code and all associated OtherCode elements must be present.
A state/province code, local code, other code or a text string that crosswalks to or serves as a translation of an associated Code element.
Describes the OtherCode element content as either a state/province code, a local code, other code, or text string.
This gives information about a student's meal status.
Date on which meal status became effective (inclusive).
Date on which meal status was last in effect, if in the past.
This element can't exist without a StartDate.
School year for which the information is applicable, expressed as the four-digit year in which the school year ends
(e.g., 2004 for the 2003-04 school year).
Meal status type.
This gives information about a staff member's meal status.
Date on which earned status became effective (inclusive).
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.
Earned status type.
This gives information about a meal type.
This gives information about a meal type.
A commonly defined container for metadata elements defined within SIF.
A common metadata element designed to contain time data, both self-defined and by type.
This element is designed to contain the time period attached to an object.
Very long periods (school year, quarter, etc.) and very small periods (second, millisecond, etc.) can be defined.
This element provides a scoping description of the time metadata enclosed.
This element provides a place for the application to send structured data (code values, unique identifier, timestamps).
This code value can, depending upon the use case agreement between agents, be used to qualify the data in the
Contains a human-readable description of the value in
Contains the human-readable value.
This element allows for the system to tag an object as being explicitly current.
Although the baseline assumption in SIF is that objects are always current (default value is typically
This common metadata element describes the life cycle of the object it represents, based on the IEEE LOM LifeCycle element [LOM].
Human-readable name of the data's creator. If the object contains system-generated data,
the name should identify the creating service or application.
Unique identifier of the creator. An email address or URI could be used here.
Identifier of the system or person that modified the data.
The date/time the modification occurred.
Human readable description of the data modifications.
A common metadata element designed to carry any intellectual property or copyright information, based on the IEEE LOM Rights element [LOM].
A description of the fee structure for this resource.
Some resources may be licensed differently depending upon their context.
For example, a content provider might charge one fee structure for resources used in the classroom and a separate fee for those
resources available to parents from home.
This object defines the data that is being aggregated as well as the type of measurement that is being performed.
Name of Aggregate Statistic
Rule for calculating the aggregate statistic
Date for which the statistic is initially valid
Date after which the statistic is no longer valid
Rule for which statistic may not be reported
System providing the data: i.e., SIS, Transportation,
Effective date of the statistic
Discontinue date of the statistic
Name of the location
RefId of the location object if the location is a SIF object such as SchoolInfo.
Type of SIF object Location points to.
Type of the statistic.
Key
This object defines the attribute of a group of objects that implicitly or explicitly defines a subset of the group.
Describes the supercategory of the characteristic described in the Definition element below.
Defines the aggregate characteristic information.
Reference to SIF elements or external authority (e.g., StudentPersonal/Gender).
Key for aggregate characteristic information.
This object is the actual value of the measurement. It is always associated with one statistic and one or more characteristics.
Reference to statistic defined by
Reference to an AggregateCharacteristicInfo object.
Value of the fact.
This object communicates the current meal/account status of a given student.
The student's current meal status.
The student's meal status. Note that as this status is historical, StartDate and EndDate together,
and/or SchoolYear MUST be included. If SchoolYear is included,
StartDate and EndDate should not cross school year boundaries, i.e. in addition to multiple
statuses being a possibility in a given school year, the same status may be repeated so StartDate and EndDate don't
disagree with SchoolYear, if included.
Date of the last reimbursable breakfast served.
Date of the last reimbursable lunch served.
The GUID of the student to whom this object is linked.
Item number as presented to user.
Description of Item
Electronic identifier(s) associated with this item.
The category is derived from the Child Nutrition Database's food category codes/names (Source: Food Category Name File [CNDB]).
Agents may use the actual codes or a district's local definition of the names associated with the codes.
The Child Nutrition Database [CNDB] is updated on a yearly basis by the USDA.
GUID that identifies this item
This object describes the unit for an item.
GUID that identifies related item
Description of unit ("cup", "teaspoon", etc.)
Child Nutrition Database [CNDB] standard code describing unit. Â The database is updated on a yearly basis by the USDA.
Gram weight of this item in terms of MeasureDescriptionCode
GUID that identifies this unit
This object describes a certain amount for a specific item unit.
GUID that identifies related item portion
Quantity of item portion (number of units)
Type of item unit
Optional description of amount
GUID that identifies this item's portion
This object describes the federal, state, local and other reimbursement rates for a school.
GUID that identifies the school.
Effective start date for the reimbursement rates
Effective end date for the reimbursement rates
The name of the reimbursing agency. This element is to be used when the Type is set as Other.
The rate value
Severe need identifier for the rate. When SevereNeed is Yes then the rate shown is the combined rate.
For certain programs the severe need identifier does not apply. In such cases the value NA should
be used.
Type of the reimbursing agency.
GUID that identifies this object.
This object is a site's meal prices for each grade program, meal status, meal type and grade level.
GUID that identifies the school this meal price belongs to
The price value
GUID that identifies this meal price.
This object communicates the current meal status and account status of a given staff member. This object indicates
whether the staff member is entitled to earn meals.
Last breakfast served date
Last lunch served date
The GUID of the staff to whom this object is linked.
This object communicates food service transaction information. This is the key object that will be present for every
food service transaction.
GUID that identifies the school/site of account transaction
Date of transaction
Time of transaction.
Type of transaction
The GUID of the customer doing the transaction.
SIF customer type.
Amount of tax.
Description of the Transaction
This flag tells us if the transaction is voided.
GUID that identifies food service transaction
This object gives the transaction distribution for food service transactions of type other than Purchase. So, this
object can be requested for transactions of type Prepayment, Repayment, Refund, Adjustment.
GUID that identifies food service transaction
This amount refers to the funds being directed inwards to/outwards from the customer's account. That is: these amounts reflect the changes to the account balances.
Description
GUID that identifies transaction details
This object communicates the funding for a given transaction. By the term funding we refer to the form of payment
that is made for the transaction.
GUID that identifies food service transaction
This amount is the form of the incoming funds for this transaction. For example; the payment can be made by a credit card.
This refers to the way the payment was made.
GUID that identifies the payment
This object communicates the daily sales information.
School for which the sales object applies
Date on which the sales occurred.
Monetary value
Type of SalesAmount. This denotes the form of incoming funds for the sales done.
Type of account to which sales amounts apply. This is set to NA when Type is set as Earned.
GUID that identifies the daily meal sales object
This object gives the sales details for the items sold for a specified date.
GUID that identifies the school for this object
Date of sales
The value of item quantity
The cost (monetary value) of the item sold.
GUID of FoodserviceItemPortion object
GUID that identifies this object
This object communicates the foodservice menu plan for a school site for a given meal program, grade level range and date.
GUID that identifies the school for this menu plan
Date of menu plan
Description of menu plan
Feeding figure projected
Quantity of item in this menu plan
Item portion amount
GUID that identifies this menu plan
This object communicates the daily milk sales at a school.
School for which the sales object applies
Date on which the sales occurred.
The quantity sold.
Unit of Sale
Charge to child per unit
GUID that identifies the daily milk sales object
If a food service transaction is of type Purchase then this object can give the details of the purchase.
This object does not exist for other transaction types.
GUID that identifies food service transaction in which this purchase was made
The value of quantity
Foodservice Item Portion
Identifies whether the item being purchased is earned i.e., at no cost to the buyer. It is used when FoodserviceTransaction object's TransactionType element has the value "Purchase".
GUID that identifies purchase transaction
This object communicates the staff enrollment for a specified date.
Reference to SchoolInfo
Date the count is taken.
This object communicates the daily staff sales.
School for which the sales object applies
Date on which the sales occurred.
GUID that identifies the daily meal sales object
This object communicates the student enrollment for a specified date.
Reference to SchoolInfo
Date the count is taken.
This object communicates the daily student sales.
School for which the sales object applies
Date on which the sales occurred.
GUID that identifies the daily meal sales object
This object contains references to the set of records associated with and available for a given student.
A unique student identifier outside of SIF.
A locally-defined student identifier.
An associated StudentPersonal object.
The GUID that uniquely identifies an instance of this object.
Conveys a student's demographic data for student record exchange and transcript purposes.
The date this record was prepared.
The address of the student.
The ID (GUID) of this record.
The GUID of an associated object, either StudentRecordExchange or StudentPersonal.
The associated object type.
This object conveys a student's academic record data for student record exchange and transcript purposes.
The date this record was prepared.
References the school of record for the student (see SchoolAttended).
The date the student originally enrolled in the district of the school of record.
Accrediting body for the school.
The text name of the value list ("Letter Grades", "Letter Grades (+/-)", "ESU", "Pass/Fail", "Override Grades", "Citizenship Comment Codes", etc.).
The minimum percent value accepted for this mark. If present, the publisher of this object is required to ensure that any values present in the StudentSectionMarks object will not be lower than this value.
The maximum percent value accepted for this mark. If present, the publisher of this object is required to ensure that any values present in the StudentSectionMarks object will not be higher than this value.
Number of significant digits.
Number of decimal places.
Lowest Mark in the range (e.g., 98, 3.95).
Highest Mark in the range (e.g., 100, 4.0).
String representing the actual Mark that would appear on the report card (e.g., "A+", "I", "100").
Numeric equivalent for the Mark (e.g., 100, 4.0).
The description for this code. (e.g. "Excellent", "Participates in Class", "Incomplete", etc...).
In a Change event, this flag can be used to indicate an element has been deleted from the parent list container.
At a minimum the key for the list must also be present.
An integer value representing the maximum number of Unicode characters for the narrative, the UTF-8 encoding of which may be longer.
ID used internally to StudentAcademicRecord to link marks to their marking systems.
ID used internally to StudentAcademicRecord to avoid duplication of school-related data.
Note: Mandatory if student exited school.
Reference to SchoolAttended.
Reference to the school of record for the courses being taken (see SchoolAttended).
Reference to the school where the course is being taken (see SchoolAttended); may be omitted if the school is the same as the school of record.
Date course section started.
Date course section ended, or will end.
Student's grade level at time of course.
The percent score for this mark (0.00 - 100.00).
The raw numeric score for this mark.
The letter grade for this mark.
The free form text narrative for this mark.
Reference to marking system at school of record.
Number of course credits attempted.
Reference to the school of record for the time span (see SchoolAttended).
Reference to the school where the course was taken (see SchoolAttended); may be omitted if the school is the same as the school of record.
Date course section started.
Date course section ended.
Reference to the school where student took the course during the marking period, if different from schools above.
Student's grade level at time of course.
The percent score for this mark (0.00 - 100.00).
The raw numeric score for this mark.
The letter grade for this mark.
The free form text narrative for this mark.
Reference to marking system at school of record.
Number of course credits attempted.
Number of course credits earned.
Type of credit.
Flag indicating that the student was excessively absent from the class.
Number of days absent.
Number of days present.
Student's grade level at time.
Number of credits attempted.
Number of credits earned.
Number of GPA credits attempted.
Number of GPA credits earned.
Number of GPA points received.
Grade point average for term.
Weighted grade point average for term.
Number of days absent.
Number of days present.
Total credits attempted during academic career.
Total credits earned during academic career.
Cumulative number of GPA credits earned during academic career.
Cumulative number of grade points earned during academic career.
Cumulative grade point average for academic career.
Brief name/description of type of GPA.
Student's rank in graduating class.
Total number of students in student's graduating class.
Date class ranking was determined.
Projected graduation date.
Note: Mandatory if graduated. Graduation date.
Note: Mandatory if graduated. Type of diploma earned.
An indication of the general nature and difficulty of instruction provided throughout a course.
Textual description of assessment.
Date the assessment was administered.
Form, version or edition of the test.
Free-form text description of the level of the test.
Student's grade level when assessed.
The subtest or subject category of the assessment.
Type of test score.
Test score.
Textual description of the requirement.
The method by which the requirement was met.
Student's status with regard to the requirement.
Date the student's status was determined.
The title that identifies a particular co-curricular or extra-curricular activity.
The code used to identify the co-curricular or extra-curricular activity in which the individual is involved.
The month, day, and year on which the individual began to participate in the activity.
The month, day, and year on which the individual ceased to participate in the activity.
An indication of the degree to which the individual is involved in the activity (e.g., number of hours per week).
A designation of the type of academic distinctions or other honors earned by or awarded to the student.
A textual description of the distinction or honor.
The nature of recognition given the student for the successful completion of work in high school.
A textual description of the recognition.
The ID (GUID) of this record.
The GUID of an associated object, either StudentRecordExchange or StudentPersonal.
The associated object type.
Conveys a student's special education program information for student record exchange.
The date this record was prepared.
The ID (GUID) of this record.
The GUID of an associated object, either StudentRecordExchange or StudentPersonal.
The associated object type.
Wraps content or a record not defined by SIF but that is part of a student's records.
The GUID of an associated object, either StudentRecordExchange or StudentPersonal.
The associated object type.
This object defines the types of values allowed for a mark and the domain for each mark value. At least one of the Percentage, Numeric, Letter or Narrative nodes must be used to create a valid MarkValueInfo.
The year that this MarkValueInfo applies to.
The text name of the value list ("Letter Grades", "Letter Grades (+/-)", "ESU", "Pass/Fail", "Override Grades", "Citizenship Comment Codes", etc.).
The minimum percent value accepted for this mark. If present, the publisher of this object is required to ensure that any values present in the StudentSectionMarks object will not be lower than this value.
The maximum percent value accepted for this mark. If present, the publisher of this object is required to ensure that any values present in the StudentSectionMarks object will not be higher than this value.
Indicates whether a percent Mark is accepted and is used in Change events to unambiguously signal whether support for the Mark has changed, especially ended.
Number of significant digits.
Number of decimal places.
Lowest Mark in the range (e.g., 98, 3.95).
Highest Mark in the range (e.g., 100, 4.0).
Indicates whether a raw numeric score is accepted and is used in Change events to unambiguously signal whether support for the score has changed, especially ended.
String representing the actual Mark that would appear on the report card (e.g., "A+", "I", "100").
Numeric equivalent for the Mark (e.g., 100, 4.0).
The description for this code. (e.g. "Excellent", "Participates in Class", "Incomplete", etc...).
In a Change event, this flag can be used to indicate an element has been deleted from the parent list container. At a minimum the key for the list must also be present.
Indicates whether a letter Mark is accepted and is used in Change events to unambiguously signal whether support for the Mark has changed, especially ended.
An integer value representing the maximum number of Unicode characters for the narrative, the UTF-8 encoding of which may be longer.
Indicates whether a narrative is accepted and is used in Change events to unambiguously signal whether support for a narrative has changed, especially ended.
The ID (GUID) that uniquely identifies this MarkValueInfo entity.
The ID (GUID) that uniquely identifies the School that these Mark Values apply to.
This object defines each mark that can be recorded and associates it with a MarkValueInfo object that lists the types of values and valid values for each type. It also
places the definition in the context of a school and a school year.
The year that this MarkInfo applies to.
Textual description of the type of Mark (e.g. "Marking Period Grade", "Comment 1", "Comment 2", "Conduct", "Effort", "WorkHabits").
The ID (GUID) that uniquely identifies this Grading Mark entity.
The ID (GUID) that uniquely identifies the MarkValueInfo.
The ID (GUID) that uniquely identifies the School that this Mark applies to.
This object defines the marking periods (TermInfo) that marks (StudentSectionMarks) are recorded in for a particular section (SectionInfo) and lists the types of marks (MarkTypeInfo) that are valid for that marking period (TermInfo).
The ID (GUID) that identifies a mark that this class uses for grading.
The ID (GUID) that identifies the marking period that the following marks are recorded in.
The ID (GUID) that uniquely identifies the SectionInfo object that this item refers to.
The ID (GUID) that uniquely identifies the School that these Mark Values apply to.
This object contains the marks entered for a student in a class section for a specific marking period.
Indicates if the grades are "Final" from the perspective of the teacher or school. Does not mean that change events will not occur for this item.
The percent score for this mark (0.00 - 100.00).
The raw numeric score for this mark.
The letter grade for this mark.
The free form text narrative for this mark.
The ID (GUID) that identifies a mark that was given for this student.
The ID (GUID) that uniquely identifies the StudentPersonal object that this item refers to.
The ID (GUID) that uniquely identifies the SectionInfo object that this item refers to.
The ID (GUID) that identifies the marking period that the following marks are recorded in.
The ID (GUID) that uniquely identifies the School that these Mark Values apply to.
This object provides information about a particular grading category to provide grouping and type information for assignments.
The name/short description of the category.
GUID that identifies a grading category.
The GUID for the SectionInfo object that this category is used for grading in.
The GUID for the TermInfo object that defines the marking period that the category was created in.
The ID (GUID) that uniquely identifies the School that these Mark Values apply to.
This object provides information about a particular assignment, allows applications to synchronize each other's assignment tables, gathers the definition for a GradingAssignmentScore object, etc.
The text-based description of the assignment.
The points possible on the assignment.
Creation date of the assignment.
Date the assignment is due.
The weight of the assignment.
This element defines the assignment.
If the Type attribute is URL, this is the location of the document that describes the assignment.
If Type is PDF, this element will contain the Base64 encoding of the entire document.
The type of information that is contained in the DetailedDescription element.
A GUID that identifies GradingAssignment.
The GUID for the SectionInfo object.
The GUID for the TermInfo object that defines the marking period that the assignment was created in.
The ID (GUID) that uniquely identifies the School that these Mark Values apply to.
The GUID for the GradingCategory that this assignment is part of.
This object provides score information about a particular assignment.
The score represented as points. Conditionally required that one or more of ScorePoints, ScorePercent or ScoreLetter must be filled in.
The score represented as a percent. Conditionally required that one or more of ScorePoints, ScorePercent or ScoreLetter must be filled in.
The score represented as a letter grade. Conditionally required that one or more of ScorePoints, ScorePercent or ScoreLetter must be filled in.
Text description of the score.
The GUID that specifies the school this score was recorded at.
This object provides attendance for a student in the context of a SectionInfo object.
This object is used by all agents in a zone that provide period attendance,
but don't have the logic to determine whether or not they have sufficient rights to override attendance from another user or system.
Agents that represent a system that can validate attendance based on, among other things, its source, should subscribe to
StudentPeriodAttendance events to collect "suggested" attendance changes from the zone,
and should then publish "accepted" attendance changes as OfficialStudentPeriodAttendance events.
A rejected change would result in an event that reverts the system that generated the rejected event back to its previous state
or to some other state that represents the correct "official" attendance.
The period within which attendance is being reported, e.g. "4D". Conditional on the SectionInfo object having MeetingTime elements. If one or more are defined for the Section, this element is required.
The time the student entered or returned to this class.
The time the student left this class.
The local attendance code.
Unique identifier of the user that created the attendance record. This will depend on the user and the source. The preferred identifier would be a RefId for a StaffPersonal, StudentContact, or StudentPersonal Object. However, the user may not be associated with any of these SIF objects. In that case a unique ID given by the source should be used.
The role of the staff member for that created this attendance record.
The date and time of this attendance record was created.
This element contains the comments that are relevant to this attendance record.
The GUID of the student that this attendance applies to.
The GUID of the section that this attendance applies to.
The school where the attendance was recorded. Somewhat redundant, needed for requests.
The date of the attendance event.
This object provides attendance for a student in the context of a SectionInfo object. It is used to represent the final/official attendance that has been assigned to a student. Only one agent in a zone should generate events for this object. That agent is responsible for receiving and validating all StudentPeriodAttendance events and
for generating a corresponding OfficialStudentPeriodAttendance event once any unofficial events have been processed.
This object provides attendance for a student in the context of a SectionInfo object. It is used to represent the final/official attendance that has been assigned to a student. Only one agent in a zone should generate events for this object. That agent is responsible for receiving and validating all StudentPeriodAttendance events and
for generating a corresponding OfficialStudentPeriodAttendance event once any unofficial events have been processed.
This object contains an amount to be billed to an outside entity.
ID of the entity being billed for this billing activity (e.g., student, employee, organization).
SIF object referenced by SIF_RefId.
Date of the transaction.
Description of the transaction.
Amount to be billed.
GUID for this transaction. The application that owns this object is responsible for generating this unique ID.
This object complements the Billing object, and contains information about the payment of a Billing object.
Date payment was received.
Amount received.
Memo transaction ID from other vendor software.
Description of the transaction.
GUID for this transaction. The application that owns this object is responsible for generating this unique ID.
A pointer back to the Billing object.
This object defines information related to an employee assignment as it pertains to the human resource needed to track employee assignment for employee reporting and financial funding tracking.
The staff assignment record will hold more detail of the actual assignment.
There are multiple records for each assignment and/or location.
Short assignment description
This is an optional element so the placement of the employee within the agency can be tracked as needed.
The GUID references the LocationInfo object.
This is the date from which the staff assignment is valid (inclusive).
This is the date through which the staff assignment is valid (inclusive). Present if the JobStartDate is entered and a JobEndDate is available.
Full-time job equivalent ratio for this assignment. (Format is x.xx; an employee who is full-time and who spends 50% of their time on this assignment would be represented as 0.50)
The specific group of duties or responsibilities of position.
The type of instructional or non-instructional program.
Provider of funds for the program or service.
The GUID that uniquely identifies a particular HR staff assignment.
This GUID referencing the parent EmployeePersonal object
This object contains HR contract information related to employees.
Base salary of employee for this contact
Contractual start date.
Contractual ending date.
Contractual Term in school years
Number of days in service for contract total
Number of days per year employee is expected to work in this assignment
The GUID of the employee contract information.
The GUID that refers to the EmployeePersonal object.
Staff is currently active and/or employed.
Full-time status of employee.
Date the employee was hired.
Date the employee resigned. Present if a HireDate is entered and a TerminationDate is available.
Total number of years of prior experience.
Employee's current position title.
Employee's level or category assigned by employer.
Date employee has seniority.
Date employee is tenured.
The GUID can either refer to the EmployeePersonal or StaffPersonal object.
This object contains basic HR information for employees.
This field can hold a SSN, state or locally assigned ID.
Name of employee.
This element contains information related to employee demographics.
The employee's address(es).
The employee's phone number(s).
The employee's e-mail address(es).
The GUID that uniquely identifies this employee.
This object contains information about an employee's picture.
This element defines the picture. If the Type attribute is URL, this is the location of the picture in [JPEG] format; if Type is JPEG, this is the [JPEG] image data encoded using the Base64 Content-Transfer-Encoding defined in Section 6.8 of [RFC 2045].
The way the picture is specified.
This is the GUID of the Employee whose picture this is.
This object contains information about account code annual financial totals, summarized by major and/or minor
account code breaks.
Date on which snapshot was generated.
State assigned reporting ID for district or agency
Fiscal year of summary account
Classification of budgetary account code summary
Is the account a general or special account code designation?
State-assigned ID for the relative area in which the expenditure/revenue was used.
Relative area in which the expenditure was used.
Function break in account code for summarization.
Object break in account code for summarization.
Instructional program break in account code for summarization
Summarized amount.
With regard to regional/local education service agencies report of "special" account code information, the account code summarization can be classified as:
Special Education
Transportation
Early Intervention
Institutionalized Children
Other
General Ledger Amount Type. With regard to an account code grouping classified as a General Ledger account:
Administration
Curriculum Development and Improvement
Education Planning
Instructional Materials
Management
Continuing Education
Pupil Personnel
State and Federal Liaison
Federal
Medical Assistance
Auxiliary services of non-profit private and parochial schools
Other
This object contains information about account code budget totals, summarized by major and/or minor account code
breaks. It is a snapshot object used to allow a district to report summarized financial budgetary
information to their state as required.
Date on which snapshot was generated.
State-assigned identifier for this location
Fiscal Year of summary account
Classification of budgetary account code summary
Fund breakdown of account code for summarization.
Function breakdown of account code for summarization.
Object breakdown of account code for summarization.
Summarized, positive amount without cents for breakdowns
This object contains information about the time worked by an employee on a specific job.
References associated EmployeePersonal object.
Site where employee actually worked. References LocationInfo object.
Code representing the type of job function.
Regular hours worked. Enter 0 if no hours worked.
Overtime hours worked. Enter 0 if no overtime hours worked.
Pay period hours were worked in.
GUID for this object. The application that owns this object is responsible for generating this unique ID.
This object contains basic vendor information.
Name of the vendor.
Contact information.
Account number or other ID.
When the vendor and employee are the same, it may be appropriate to link the EmployeePersonal records to
the VendorInfo when tracking expense and tuition reimbursement. This is the GUID of the associated EmployeePersonal object.
Send 1099 to this vendor.
Taxpayer identification number/Federal tax ID for this vendor.
The type tax ID that this is. TIN based on IRS Publication 1915 [IRSTIN].
Vendor ID.
This object contains the information completed on a W4 tax form. (Please note that this object is defined to
represent the current deductions allowances for the employee; this is not intended to circumvent or replace IRS
reporting standards but to faciliatate movement of W4 data from system to system within the LEA.)
Date W4 was completed.
This denotes the current martial status of the employee
Number of federal allowances.
Number of state allowances.
State of residence.
Is this employee exempt from federal and state exemptions?
This is the GUID that points to the employee represented in the EmployeePersonal object.
This object contains HR/payroll employee information used to define how to pay an employee per pay cycle.
Pay amount.
Percentage of pay this represents.
Type of pay
Per pay
Hourly
Per diem
Extra pay
The GUID of the employee's pay information.
The GUID that refers to the EmployeePersonal object.
LocationInfo represents a location in a district.
Specific site category.
Text name of the location
Description about the location.
The locally-assigned identifier for this location.
The state-assigned identifier for this location.
The NCES-assigned identifier for this location.
The ID (GUID) that identifies the district.
The ID (GUID) of an other related education agency, such as a regional service agency.
A LocationInfo instance could be related to another LocationInfo. This element will help create that relation.
The name of the object referenced.
The RefId of a corresponding SchoolInfo object.
This element has the LocationInfo address information.
The location's phone numbers.
The SIF unique identifier for the location.
Defines whether the location is a school or a non-school location.
This object provides information down to the line item level for requisitions and purchase orders.
Type of purchasing document.
Purchase order
Requisition
Requisition or PO number.
Reference to fiscal year for the transaction.
This object references the VendorInfo object and should be considered mandatory when FormType="PO"
The building ID for this purchasing activity.
The employee ID for the originator of this purchasing activity.
Vendor item number.
Description of the item.
Quantity ordered.
Unit cost of the item.
Account code charged to this item.
Amount charged to this account.
Transaction GUID for this purchasing activity. The application that owns this object and is responsible for generating this unique ID.
This object defines an accounting period within a fiscal year.
Name of the accounting period.
Fiscal year to which this accounting period belongs.
Start date of the accounting period.
End date of the accounting period.
GUID that identifies this accounting period.
This object communicates information about a financial account.
Account number used for ledger.
Name of the account.
Description.
Financial class of the account.
Account creation date.
Account creation time.
GUID that identifies this financial account.
This object relates financial account to an accounting period and a location.
Financial account reference.
Accounting period reference.
LocationInfo reference.
GUID that identifies this object.
This object communicates financial class information. Financial classes are used to categorize financial accounts.
Name of the financial class.
Description.
GUID that identifies this financial class.
This object communicates the income statement details for a location and an accounting period.
Generation date.
Generation time.
LocationInfo reference.
Start date.
End date.
Amount in the account.
FinancialAccountAccountingPeriodLocationInfo reference.
Class of the financial account.
GUID that identifies this income statement.
This object communicates a financial transaction. A transaction can be for the daily food sales revenue account.
Transaction date.
Transaction time.
Monetary amount of the transaction.
Account.
GUID that identifies this financial transaction.
This object defines a fiscal year.
A description of the fiscal year.
Start date of the fiscal year.
End date of the fiscal year.
GUID that identifies this object.
This object contains information about educational providers of professional education courses and activities.
Local code used to represent this provider
State assigned provider number
Name of the provider.
This element contains information related to provider's address information.
GUID for this object. The application that owns this object is responsible for generating this unique ID.
This object contains information about courses and activities taken by employees.
Date in which the course or activity was completed and awarded credit.
The number of units earned
The unit description
This is the GUID for this object.
References EmployeePersonal object.
References the ProfessionalDevelopmentActivities object
This object contains information about employee continuing professional course and activity credits and hours taken
by employees for recertification purposes. It is used as a vertical reporting snapshot-type object to transmit
information regarding professional continuing education courses and activities completed by employees to maintain
their current educational certification(s) within a given state.
Employee Social Security Number
Name of employee.
This element contains information related to employee demographics.
Name of the course or activity
Type of course or activity
Total activity hours/total clock hours
Hours attended or credits earned by the employee
Number of hours or credits.
Start date of the course or activity
Ending date of the course or activity
This object contains HR, certification and teaching assignment information for elementary and secondary
professional personnel for state reporting. It is a snapshot object used for vertical reporting of data related to K-12
elementary and secondary professional employees.
Date that report snapshot was generated
School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2004" for the 2003-04 school year).
State assigned reporting unit number
Employee social security number
Name of employee.
This element contains information related to employee demographics.
Primary employee's race
Is this employee Hispanic or Latino?
Certification description as defined by state
Area in which employee has certification
Employee's salary
Employee professional position status
Is this employee on leave this year?
Total number of years employee has been in a professional position
Total number of years at current LEA
Highest level of education attained by employee.
Category in which teacher is authorized to teach
If appropriate, employment separation reason
Background check type
Date on which background type was checked
Description of background check performed
References SchoolInfo object to determine school in which this assignment pertains.
Grade which is assigned to this employee (e.g. 12)
Code representing the type of job function.
Full-time equivalent for this school
This object contains information about courses and activities for which employees can earn credits or hours to
maintain their certification.
Locally assigned number or provider referenced course number used to represent the course or activity
The starting date of the course or activity
The ending date of the course or activity
The description of the course or activity
The actual number of hours required for the course or activity
Number of credits that can be earned by completing the course or activity.
GUID for this object.
References the ActivityProvider object
This object contains information pertaining to student eligibility for and participation in an individualized special program such as special education, ESL, Section 504, etc.
Effective date (NOT the entry date) of this StudentParticipation instance for the identified student and program.
Each time there is a change to the student's program participation profile, a new instance of this object is to be generated with
the appropriate StudentParticipationAsOfDate and a new RefId.
Funding source for the program, may be more than one.
Funding source for the program, may be more than one.
Funding source for the program, may be more than one.
Education for the Disadvantaged, ESEA I-A
English Language Acquisition, Language Enhancement and Academic Achievement, ESEA III-A
Foreign Language Assistance, ESEA V-D
Gifted and Talented, Javits, ESEA V-D