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.4. 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 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: Agent SourceIdList. 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. 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. Contains protocol information regarding 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). 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. This element is used to signal an unsuccessful response. 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 select objects; 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. 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. 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 name of the object containing the element/attribute. 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. 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. SIF_Event is used to deliver event objects as defined in SIF. 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. Whether or not the Agent supports SIF_ExtendedQuery for this object. 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. Whether or not SIF_ExtendedQuery is supported with regard to this object. The name of each object. The name of each object. The name of each object. The name of each object. The name of each object. Optionally specify whether or not SIF_ExtendedQuery may be sent in requests for this object. The name of each object. Whether or not SIF_ExtendedQuery is supported with regard to this object. The name of each object. The name of the SIF Zone Service as defined by a SIF Zone Service specification The name of the SIF Zone Service as defined by a SIF Zone Service specification A specific method that the agent invokes the specified SIF Zone Service The name of the SIF Zone Service as defined by a SIF Zone Service specification A specific event that the agent desires to subscribe to The name of the SIF Zone Service as defined by a SIF Zone Service specification SIF_Register is the message for registering an agent with a ZIS. This is the descriptive name of the agent that is registering (i.e. Ramsey Media Center). Specifies the SIF Implementation Specification version(s) defining messages the agent can receive. 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. 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. Specifies which SIF Implementation 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. SIF_Response is used to respond to a SIF_Request message. 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 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 message is used to subscribe to event objects that are contained in this message. 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. 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 sub-message asks a receiver (ZIS or Push-Mode Agent) to cancel the specified SIF_Requests, pending or in process. ZIS will send a "final" SIF_Response for each cancelled SIF_Request. No further SIF_Responses for these requests will be placed in the Agent's queue. This is the The SIF_SystemControl message is already part of the SIF Infrastructure. This messages allows for synchronous communication between an agent and a ZIS. The SIF_SystemControl - SIF_CancelServiceInputs allows an agent or ZIS to notify the other party that the specified SIF_ServiceInput should be cancelled. ZIS will send a "final" SIF_ServiceOutput for each cancelled SIF_ServiceInput. No further SIF_ServiceOutputs for these requests will be placed in the Agent's queue. This is the This message performs the opposite function of SIF_Provide. The actual name of the object that is being removed. This message is used to unregister an agent from a Zone. This message is used to unsubscribe from SIF_Events. 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. SIF_ServiceInput is used to invoke a method that is exposed by a SIF Zone Service. The name of the SIF Zone Service that is being invoked. This is the name of the service operation that is being invoked. The unique ID of this service request invocation. Multiple SIF_ServiceInput packets may be sent with this same SIF_ServiceMsgId Specifies which SIF Specification version should be used when returning the response data. If a responder cannot return response data in this format, it should reject the SIF_ServiceInput. It is recommended that clients use a wildcard version for the “minor” portion of the version, such as "2.*". 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. If the maximum size is too small to contain a single whole response object, the responder should reject the SIF_ServiceInput. To guarantee delivery of response packets, requesting agents must not specify a SIF_MaxBufferSize greater than its registered SIF_Register/SIF_MaxBufferSize. This element represents the index of the SIF_ServiceInput 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 service request. The value of this element can only be "Yes" or "No". SIF_Body contains a single child element that has the same name as the value of the SIF_Operation element. The structure of this element is defined by the XML Schema that is defined for the Service. SIF_ServiceOutput is used to respond to a SIF_ServiceInput message. This element represents the value of the SIF_ServiceMsgId that was sent as part of the original SIF_ServiceInput message stream, and should contain the same value to allow the client and the ZIS to associate each SIF_ServiceOutput packet with the SIF_ServiceInput message stream. This value uniquely identifies the entire set of SIF_ServiceInput and SIF_ServiceOutput messages involved in a single invocation of a SIF Zone Service method. This element represents the index of the SIF_ServiceOutput 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 value of this element can only be "Yes" or "No". SIF_Body contains a single child element that has a name composed of the value of the SIF_Operation element concatenated with the string "Response". For example a SIF Zone Service Operation with the name "GetWeather" would have in it’s response SIF_Body a single child element with the name "GetWeatherResponse". The structure of this element is defined by the XML Schema that is defined for the Service. SIF_ServiceNotify is used to deliver notifications to service clients that some state associated with the service has changed. The name of the SIF Zone Service that initiated the event The name of the notification message being sent A unique IdRefType that has been assigned to this series of messages. All SIF_ServiceNotify messages that contain this ID correspond to the same event instance. This element represents the index of the SIF_ServiceNotify message in the sequence of packets that make up a complete notification message stream. Its value must be in the range of 1 through n, with n equal to the total number of packets that make up the message stream. This element provides an indication as to whether there are more packets besides this one to make up a complete notification message stream. The value of this element can only be "Yes" or "No". SIF_Body contains a single child element that has the same name as the value of the SIF_Operation element. The structure of this element is defined by the XML Schema that is defined for the Service. This object provides an Agent its access control list (ACL) settings in the Zone. The name of each object. The name of each object. The name of each object. The name of each object. The name of each object. The name of each object. The name of each object. The name of the SIF Zone Service as defined by a SIF Zone Service specification The name of the SIF Zone Service as defined by a SIF Zone Service specification A specific operation that the agent has permission to invoke or subscribe to The name of the SIF Zone Service as defined by a SIF Zone Service specification A specific operation that the agent has permission to invoke or subscribe to The name of the SIF Zone Service as defined by a SIF Zone Service specification This object provides an Agent its access control list (ACL) settings in the Zone. The name of each object. The name of each object. The name of each object. The name of each object. The name of each object. The name of each object. The name of each object. The name of the SIF Zone Service as defined by a SIF Zone Service specification The name of the SIF Zone Service as defined by a SIF Zone Service specification A specific operation that the agent has permission to invoke or subscribe to The name of the SIF Zone Service as defined by a SIF Zone Service specification A specific operation that the agent has permission to invoke or subscribe to The name of the SIF Zone Service as defined by a SIF Zone Service specification This object captures an occurrence within a SIF node (ZIS or agent)—error, warning or information—for storage in an optionally provided zone log. SIF_LogEntry Adds are reported and are used to post new log entries to the provider of the log. Of course, subscribing agents may also filter incoming Adds as part of their own logging mechanism. Any Change or Delete SIF_Events should be ignored at the agent level, but should be routed by the ZIS (though this should not be necessary). Use of the log is optional and voluntary, except where noted as mandatory in this specification. Nodes may post as much or as little log data as required with the expectation that if there is a provider of SIF_LogEntry that the logged entries be available for a provider-defined amount of time subject to provider-defined restrictions on the quantity of data logged by any given node. A SIF_LogEntry category. May be omitted for informational-type postings, where typically a textual description will suffice. Success Data Issues with Success Result Data Issues with Failure Result Error Conditions A SIF_LogEntry code with regard to SIF_Category above. May be omitted for informational-type postings, where typically a textual description will suffice. If a SIF_Code is included, SIF_Category must be included as well. An error code specific to the application posting the entry. Can be used by vendors to query log entries for errors specific to their applications. If a SIF_ApplicationCode is included, SIF_Category must be included as well; i.e., application-specific error codes should fall within one of the defined log entry categories. A textual description of the error. Any extended error description. The SIF node that logged this entry. The level of the log entry herein described. This object captures an occurrence within a SIF node (ZIS or agent)—error, warning or information—for storage in an optionally provided zone log. SIF_LogEntry Adds are reported and are used to post new log entries to the provider of the log. Of course, subscribing agents may also filter incoming Adds as part of their own logging mechanism. Any Change or Delete SIF_Events should be ignored at the agent level, but should be routed by the ZIS (though this should not be necessary). Use of the log is optional and voluntary, except where noted as mandatory in this specification. Nodes may post as much or as little log data as required with the expectation that if there is a provider of SIF_LogEntry that the logged entries be available for a provider-defined amount of time subject to provider-defined restrictions on the quantity of data logged by any given node. A SIF_LogEntry category. May be omitted for informational-type postings, where typically a textual description will suffice. Success Data Issues with Success Result Data Issues with Failure Result Error Conditions A SIF_LogEntry code with regard to SIF_Category above. May be omitted for informational-type postings, where typically a textual description will suffice. If a SIF_Code is included, SIF_Category must be included as well. An error code specific to the application posting the entry. Can be used by vendors to query log entries for errors specific to their applications. If a SIF_ApplicationCode is included, SIF_Category must be included as well; i.e., application-specific error codes should fall within one of the defined log entry categories. A textual description of the error. Any extended error description. The SIF node that logged this entry. The level of the log entry herein described. 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 name of the object for which the agent can respond to requests. 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. This is the version or versions of the SIF Implementation Specification that define(s) the messages the SIF node can receive. For agents, this information was communicated when the SIF node registered with the ZIS. 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 name of the SIF Zone Service as defined by a SIF Zone Service specification The identifier of the SIF node that is providing SIF Services. 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 SIF Zone Service as defined by a SIF Zone Service specification The identifier of the SIF node that is providing SIF Services. This is the agent or ZIS identifier that would appear in the SIF_SourceId field of any SIF_Header created by the SIF node. A specific operation with a SIF Zone Service that the agent will invoke. The name of the SIF Zone Service as defined by a SIF Zone Service specification The identifier of the SIF node that will respond to SIF_ServiceInput messages. This is the agent or ZIS identifier that would appear in the SIF_SourceId field of any SIF_Header created by the SIF node. A specific notification message that the agent is subscribed to The name of the SIF Zone Service as defined by a SIF Zone Service specification The identifier of the SIF node that is providing SIF Services. 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 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 name of the object for which the agent can respond to requests. 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. This is the version or versions of the SIF Implementation Specification that define(s) the messages the SIF node can receive. For agents, this information was communicated when the SIF node registered with the ZIS. 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 name of the SIF Zone Service as defined by a SIF Zone Service specification The identifier of the SIF node that is providing SIF Services. 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 SIF Zone Service as defined by a SIF Zone Service specification The identifier of the SIF node that is providing SIF Services. This is the agent or ZIS identifier that would appear in the SIF_SourceId field of any SIF_Header created by the SIF node. A specific operation with a SIF Zone Service that the agent will invoke. The name of the SIF Zone Service as defined by a SIF Zone Service specification The identifier of the SIF node that will respond to SIF_ServiceInput messages. This is the agent or ZIS identifier that would appear in the SIF_SourceId field of any SIF_Header created by the SIF node. A specific notification message that the agent is subscribed to The name of the SIF Zone Service as defined by a SIF Zone Service specification The identifier of the SIF node that is providing SIF Services. 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 identifier for this Zone. It is the same as the SIF_SourceId that the ZIS would place in any SIF_Header that it creates. 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. Applicable grade levels as defined by SIF. The title of the content. A summary of the content. 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 LearnerPersonal, StaffPersonal, and LibraryPatronStatus. Electronic ID type. URL for a school. This is a common element used to define the locally assigned identifier associated with an entity. It is used in LearnerPersonal, WorkforcePersonal, SchoolInfo, and other objects. 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). A person's last name. A person's first name. A person's middle name or initial. This element contains address data, some of which is defined by the BS7666 International Address and Geographic Location Specification. Other elements are present for support of international addresses. Applications storing address information in the traditional line format must translate this information into the appropriate data elements below. The locally assigned identifier for this address in the publishing system. Date person began using this address. Date person stopped using this address. Dwelling name, or at least a general description of the location in lieu of having any other information. This is required when no other PAON information is provided. Start (single) dwelling number. Start (single) dwelling number suffix. End dwelling number. End dwelling number suffix. Sub-dwelling name, or other descriptive information in lieu of having any other information. This is required when no other SAON data is provided. Start (single) dwelling number. Start (single) dwelling number suffix. End dwelling number. End dwelling number suffix. The name of the street. The locality name refers to a neighbourhood, suburb, district, village, estate, settlement, or parish that may form part of a town, or stand in its own right within the context of an administrative area. Where an industrial estate contains streets it is defined as a locality in its own right. At least one of Locality, Town, or AdministrativeArea must be specified. The city name refers to a city or town that is not an adminstrative area, a suburb of an administrative area that does not form part of another town or a London district. At least one of Locality, Town, or AdministrativeArea must be specified. The administrative area is a geographic area that may be the highest level local administrative area, and may be a county or a unitary authority, an island or island group, or London. At least one of Locality, Town, or AdministrativeArea must be specified Where applicable, the name of the county. Post Office usually assigns these based on Sorting Office. The code allocated by the Post Office (within GBR) to identify a group of postal delivery points. Valid Postcode formats are: Country where physical address is located, if known. Usually this is going to be 'GBR' but could be outside the UK. The unique Property and Land Reference Number (UPRN) for this address. Numeric: 1 to 12 digits. The unique Property Street Reference Number (USRN) for this address. Numeric: 1 to 8 digits. The physical location of an address in terms of Census District, LA Electoral Ward, Parliamentary Constituency, and other defining location-centric characteristics. The physical property location coordinates. Code that defines the address type. 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. A list of contact persons associated with a school or LA. The contact person's position title within the school or LA. Role played by this contact in the school or LA. Any descriptive text is allowed here. Indicates whether or not this contact's information should be published in a directory of school or LA information. The ID (GUID) of the person listed as a contact. Note that this is any person listed as a contact through either a ContactPersonal, WorkforcePersonal, or even a LearnerPersonal record. The object type being referred to. The 3-character alphabetic country code defined by ISO 3166-1. Given this code all other code and name information can be obtained directly from the standard. Demographic information about a learner, contact, workforce member, etc. This element occurs within objects such as LearnerPersonal, LearnerContact, etc. A list of the person's ethnicities by proportion. Person's gender. Male Female Unknown Withheld The person's date of birth. Required for learners. Optional for others. 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 individual's country of birth. The country of legal nationality (i.e. the country which issued the individual's passport). A person's country of residence. Date the person first arrived in the UK. Based on QCA Steps. (England) Step 1 Step 2 Level 1 Threshold Level 1 Secure Based on a differing scale from QCA Steps. (Wales) New to English Early Acquisition Developing Competence Compentent Fluent Not applicable This is the code that specifies the person's language. Indicates that the person is fluent in this language. A typification of the language. i.e. how is this language used? Correspondence Language First Language Multiple First Language Home Tuition Second Language Source of data on use of the specified language. The level in which the learner is taught this language at school. Indicates whether the learner studies subjects in this language at school separate from studying the language itself. The person's marital status. Indicates the learner has recently arrived from a non-English or other common UK language system. (Wales) Indicates the person's refugee/asylum seeker status as defined by the United Nations (Article 1 of the 1951 Refugee Convention). Person's religious faith. Indicates whether the person is actively attending religious education classes. Attends Withdrawn Indicates whether the person is participating in religious collective worship. Attends Withdrawn Source of person's religious affiliation code. Code to identify type of traveller/gypsy. Source of individual's recorded traveller/gypsy code. This element represents an e-mail address of one of a number of types. This attribute specifies the type of e-mail address. 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. The DfES assigned identifier for a school or other educational establishment. The list of all known Establishment ID's is extensive and available online. The general ethnic category which reflects the individual's recognition of his or her community or with which the individual most identifies. Source of inidividual's recorded ethnic code. This element contains a map location. The GridLocation element is utilised within other objects and elements. Easting coordinate format. Northing coordinate for mapping an address. Required when PropertyEasting is also specified. This is best represented in a 7.1 format. Geographical coordinate. Geographical coordinate. Required when Latitude is also specified. The 3-digit number assigned to the LA by the DfES. The official name of the LA. The physical location of an address in terms of Census District, LA Electoral Ward, Parliamentary Constituency, and other defining location-centric characteristics. National Population Census Enumeration District. ONS Ward Code ONS Ward Name ONS Parliamentary Constituency Code ONS Parliamentary Constituency Name ONS Parish Council Name Church of England Diocese Code Church of England Parish Code Roman Catholic Diocese Code Roman Catholic Parish Learning and Skills Council area code School catchment area description The Name element defines name information for a person and occurs within the PersonalInformation element. 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. Full legal 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 always required. However, when associated with a contact it may not be possible to know the family name in which case you should add the available information to the FullName element. Full given name (forename) of the person. Note that this element is always required. However, when associated with a contact it may not be possible to know the given name in which case you should add the available information to the FullName element. All other given or middle names, each separated with a single space character. 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. The family name preferred most by the person (as written). 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. The given name preferred most by the person (as written). Textual suffix like PHD, JP, BSc. A free text field for the complete name for display purposes. If this is associated with a ContactPersonal record and the FamilyName and GivenName are not both specified, then this becomes mandatory. Code that specifies what type of name this is. Birth name Current Legal name Alias / Alternative Name of Record Former Name Married Name Professional Name Code representing a National Curriculum Year Group. This is a common element used to specify a collection of supported National Curriculum Year Groups. It is used in SchoolInfo and assessment-related objects. This element contains basic personal and demographic information related to a person. This element is part of all "personal" objects, including LearnerPersonal, WorkforcePersonal, and ContactPersonal. This element contains demographic data. The person's preferred e-mail address. The person's other e-mail address(es). The person's current physical address. The person's other address(es). The person's preferred phone number. The person's other phone number(s). Electronic identifier(s) associated with this person. An "other" identifier associated with this person. Text that describes the type of this other ID. This element represents a phone number and occurs within objects such as LearnerPersonal, WorkforcePersonal, etc. Phone number. Validation: 0-9 and a leading '+' (for international calls). Phone number extension. Indicates whether or not the phone number is available to the public. Code that specifies the phone number type. 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. The alternate DfES assigned identifier for a school or other educational establishment. A list of subject areas. Subject matter. Ordinal position of period within the day (1,2,3,etc) A short period label A long period label Time the period starts Time the period ends What this period represents. Note that currently some programs represent registration, breaks and lunches as a "period" and some don't. This Type could differ from the lesson Type (see section C4) if this teacher is doing something in this period which differs from the majority of the school. teaching period registration break lunch outside school hours (eg: clubs) other non-teaching 'unused' period (on a non-rectangular cycle) A commonly defined container for metadata elements defined within SIF. A way of identifying an object in a message that is more sensitive than that typically sent within a Zone. The Impact Level that the sensitivity has been raised to. 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. A psychological construct measured by the assessment. Operationally, an assessment component or subtest is a class of scores within an assessment that might collectively represent a column within a mark book. Some assessments may consist of only one component, aspect or subtest although it is more common for assessments to have several. The name used to identify this component or aspect. The identifier used within the publishing application. Shorter description used for column headers in marksheets, etc. Longer text describing features of the component. A year with which the component grouping is applicable (by convention this is the end year of an academic year eg: 2007/8 resolves to 2008). A subject area associated with this assessment component or aspect. The assessed stage (this may well be a Keystage List, but there is no reason why it couldn’t be used for other concepts such as NcYear applicability, Level Exam Level GCSE, A-Level etc.). The gradeset associated with the component or aspect. Start date of the range validity - ranges should not overlap. If not supplied then assumed to have always been valid in the past. End date of the range validity - ranges should not overlap. If not supplied then assumed to always will be valid in the future. The minimum value in the range of marks. The maximum value in the range of marks. Defines the associated result format. Defines the format or type of result(s) awarded. The method or format of the Assessment. The supplier/originator/designer/owner of the aspect. The ID (GUID) of this aspect or subtest. High level container describing an assessment or test or common goal. Each component group contains one or more components, also known as subtests, aspects, or sub-assessments. Name of the assessment/test/goal. The identifier used for this entity within the publishing application. The supplier/originator/designer/owner of the described component grouping. A SIF identifier for an assessment result component. The ID (GUID) that uniquely identifies a component group. Represents a range of valid grades (over time) for a result. The locally assigned identifier for this grade set. The descriptive identifier for the grade set. Explanatory/usage notes for grade set. The supplier/originator/designer/owner of the gradeset. The start date from which this version is valid. The end date until which this version is valid. The visual representation of the grade. The meaning of the grade. The rank position of the grade within the set where the highest value is assumed to be the best. While duplicate ranks are allowed they are discouraged. The numeric equivalent value of the grade. The ID (GUID) of this grade set. This object describes learners assigned to take an assessment or component grouping (can represent a markbook, exam entry, or an cohort objective). Date/time assignment is created. Value supplied by publishing vendor/supplier. The ID (GUID) of a learner assigned to take an assessment. Optional reference to the class group(s) to which this will be/are drawn. The ID (GUID) that uniquely identifies the teacher or staff member who created the learner set. The ID (GUID) that uniquely identifies an instance of this object. The assessment result component group (test or assessment) associated with the set of listed learners. A session is an event where an activity is performed by or on a learner set which contributes to the attainment of the objective. Occurs at a place and time (e.g., a test is taken, assignments are handed in, a test is marked). The date at which the activity takes place. The ID (GUID) of the school that the event takes place. The activity which takes place. The current status of the session. The GUID that uniquely identifies a teacher or other staff member responsible for administering or assisting the learner with this assessment. The ID (GUID) of this session. The ID (GUID) of the set of people the session refers to. High level container describing components of the actual assessment or test paper/quiz taken by the learner. A response component group contains one or more components. Name of the assessment/test/taken. The identifier used for this entity within the publishing application. The supplier/originator/designer/owner of the described component grouping. The SIF identifier for an assessment response component. The ID (GUID) that uniquely identifies an instance of this object. The ID (GUID) of the assessment session in which the responses were collected. A single result for a learner. The school at which the assessment was taken. The date the results were achieved. A grade title, a comment, or a mark (dependent on ComponentType of associated aspect). Marks and grades should be valid in the grade set or mark set on the date the assessment was achieved. Indicates whether the result is estimated, an interim result, provisional, actual result or a target. The ID (GUID) that uniquely identifies the session associated with the result. The ID (GUID) that uniquely identifies the teacher or staff member who created the result. Explanatory/usage notes for result. Use extended elements to define additional information to be preserved with this result data including any learner demographic data known to be valid at the time of assessment and not otherwise specified. The ID (GUID) of this result. The assessment component that the result is for. The ID (GUID) of the learner achieving the results. The set of all responses provided by a learner while taking an assessment. This information represents the raw input data that is then evaluated to produce one or more scores, marks, or grades for the learner. Learner selection or response in raw format. Status of the response. The length of time the learner took to respond. The mark achieved for this item as evaluated by the assessment tool at the time of assessment. The item group within the assessment. Identifies the item on the assessment by name. Identifies the item by number on the assessment. The order in which the item was asked. The number of times a learner changes their answer or attempts a response. The ID (GUID) that uniquely identifies this response set. The ID (GUID) of the assessment response component that the responses are associated with The ID (GUID) of the Learner for whom these responses are. This object describes a single component of the assessment or test paper/quiz taken by a learner. A response component has one or more responses. The identifier used within the publishing application. Optional reference to the school associated with the administration. The supplier/originator/designer/owner of the described component. Longer text describing features of the component. A year with which the component grouping is applicable (by convention this is the end year of an academic year eg: 2007/8 resolves to 2008). The GUID that uniquely identifies an instance of this object. This object provides attendance information for a particular learner in a particular school for a particular period of time. The time can be specified as before, during, or after school and may be for any period of time, including lessons. The date of the attendance period. The time when the learner began the attendance period. The time the attendance period started. StartTime is required when this object represents a lesson The time the attendance period finished. The session within which this attendance mark applies (e.g. AM/PM). Session is required when StartTime is not specified and the object refers to a session attendance mark (i.e. AttendanceDomain is session). A label associated with the session to further describe the session, when applicable. The attendance type. The attendance mark/code. Additional comments. Required when record is specified as a correction. The date/time when recorded. When more than one record exists using the same RefId, the record with the latest timestamp is assumed to be the most current. This is possible when a record is republished due to corrections. The source of the attendance record data. Could be Workforce member, biometric device, or other. The ID (GUID) of the staff member responsible for recording this attendance information. The ID (GUID) of the group that this attendance applies to. Useful when the attendance period corresponds to a lesson time. The ID (GUID) assigned to uniquely identify this attendance record. The ID (GUID) of the learner for which this attendance mark is recorded. The school where the attendance mark was taken. This object allows a system that stores network identities and/or passwords to share them with other applications through SIF. The provider of the Identity object may only support providing an identity or a password, or it may support both. The SIF RefId of a LearnerPersonal, WorkforcePersonal, or ContactPersonal object. The type of SIF object that the SIF_RefId attribute identifies. Indicates whether or not the Person that this object refers to is the main role for this Identity. The type of source system that produced this Identityobject. The identification string for this user. The name of the field. A representation of the user's password using the given algorithm. The method used to encrypt the user's password. See the implementation details below. The name of the key to be used for decryption of the password. Left blank for hash algorithms (MD5 and SHA1). The globally unique identifier that links together separate Identity objects which reference the same Person. The SIF RefId that uniquely identifies this object. This object describes any person created as a contact at a school, LEA, or other institution, or associated with a Learner or other Workforce person. The ID (GUID) of a person referenced as a contact. Note that this GUID may be the same GUID assigned to a LearnerPersonal and/or WorkforcePersonal object record. This object contains information about a Local Authority (LA). Compare with US/Canada object: The LA's full name. URL for the main LA website. The LA's main address information. A list of the LA's other addresses, if any. The LA's primary phone number. A list of the LA's other phone number(s). A list of contacts within the LA. The GUID of the LA whose information this is. This object provides a summary of a learner's daily attendance and membership information for a given school during the time period between the StartDate and EndDate, inclusive. As such, there may be multiple instances of this object for a learner in a school over the course of an academic school year. Note that sessions are defined by each school and in most cases is two but can be any number in the range 1-10. Compare with US/Canada object: Starting date of this attendance reporting period. Ending date of this attendance reporting period. The attendance code. The attendance code type. The authorised status of the attendance code. The total number of sessions attributed to this reason between StartDate and EndDate for the specified reason. The number of sessions the learner attended school when school was in session between the StartDate and EndDate, inclusive. The number of sessions the learner was present plus the number of sessions the learner was absent (authorised and unauthorised) when school was in session during the period between the StartDate and EndDate, inclusive. The number of sessions the learner was absent from school with a valid excuse when school was in session between the StartDate and EndDate, inclusive. Note that ts column can be derived from Reason Status. The number of sessions the learner was absent from school without a valid excuse when school was in session between the StartDate and EndDate, inclusive. Note that this column can be derived from Reason Status. Number of Alternative Tuition (whole) hours attended between the StartDate and EndDate, inclusive. The ID (GUID) of the learner for whom this attendance information is being reported. The ID (GUID) of the school for which this attendance information is being reported. This object contains information related to a contact person for a learner. Compare with US/Canada object: Defines the relationship of the contact to the learner. The locally-assigned identifier for this contact. Does the individual have parental or legal guardianship responsibility for the learner? Does the contact have pickup rights? Does the learner live with this contact? Can address information be disclosed? Does the contact prefer written communcation via email? Otherwise, postal mail will be used. Should this contact be notified in case of emergency? Is this person to be contacted in case of disciplinary action? Is the contact at home during normal daytime hours? Is this person a member of the armed forces? Does this person provide daily living or personal assistance to the learner? Does the contact need a translator or interpreter? Should this contact be transferred with the Learner if and when the Learner moves? Number (1-10) indicating the order in which the person should be contacted. Note that 2 or more contacts may have the same value. Indicates the person who provided the contact sequence order. The ID (GUID) of the learner whose contact this is. The ID (GUID) of this contact. This object contains information related to a learner being excluded from one or more sessions of school. Exclusion category. Fixed Permanent Lunchtime Reason for exclusion. Date exclusion takes effect irrespective of any review or appeal. Normally this will not be the same as Date of Leaving (exitDate) and it should be noted that the learner will remain on the schools's roll for a period after this start date. Session to begin exclusion, starting with 1 for the first session of the day. In most cases there are two sessions per day but this is not always the case. Validation: Number between 1 and 10. Date exclusion concludes. Total number of sessions for which the exclusion is in effect. For lunchtime exclusions, each lunchtime for which the exclusion applies is one session. For fixed term and permanent exclusions, this is one session during the school day. For exclusions that are followed by reinstatement the actual, not the planned number of sessions should be recorded. (Exclusion sessions are used only to calculate the total allowable in a term or academic year and are not the same as an attendance session.) Is there an appeal against permanent exclusion? Date for appeal against permanent exclusion. The result of the appeal against permanent exclusion. Reinstatement Exclusion stands Reinstatement would be appropriate but not in best interest of learner given other circumstances Date learner was reinstated, if appropriate. Date head teacher notified parents, school LA, and home LA (if different) of exclusion. Date of Governors' meeting with respect to exclusion. Date of exclusion hearing/expiration of notice of appeal. The ID (GUID) of this exclusion. The ID (GUID) of the excluded learner. This object contains information about a learner's enrolment in a course (teaching group) or other (class, homeroom or registration) group. Compare with US/Canada object: Date from when this enrolment is valid. Date on which the learner's enrolment ends or has ended. The ID (GUID) that uniquely identifies this LearnerGroupEnrolment entity. The ID (GUID) of the learner to whom the enrolment information applies. The ID (GUID) of the group in which this learner is enroled. This object contains personal information related to a learner. As most learners are enroled in the school or establishment publishing this object, basic enrolment information is also provided to aid in overall SIF performance. The locally-assigned identifier for this learner. This can be the internal pupil number or any other number as determined by the publishing agent. This is an alert message that is associated with the person. This attribute specifies what type of alert message this is. Medical alert associated with the person. The level of severity of this medical alert. Unique Internal Pupil Number. Unique Pupil Number (UPN) allocated to each learner in maintained schools in England and Wales. It is an identifier for use in the educational context during a child's school career only and subject to Data Protection restrictions. Date UPN was allocated by the LA. A former UPN assigned to the pupil whilst at a school (eg temporary UPN was allocated when the pupil was first admitted to the school but subsequently replaced by the permanent UPN being retrieved from a previous school). Unique Learner Number (ULN), a 10-digit number where zero is not allowed as the leading digit. Indicates type of family structure learner is living in. Indicates if the learner is "looked after" currently. Type of care the learner is in (eg fostering, children's home). Indicates if the learner has ever been in care while at this school. Indicates if the learner in care has a personal education plan. Indicates if parents have consented to allow learner data to be shared with Connexions (Middle, Secondary and Special Schools only). Indicates if the learner has been registered on the Child Protection Register. The LA in which the learner was registered for protection. Indicates if the learner has a sibling that is also on the Child Protection Register. Learner qualifies for Gifted/Talented status. The LA in which the learner lives but not necessarily the one in which they attend school. Classification of national identity. (Wales) The usual mode of travel normally used by the learner for the greater part (in distance) of the journey to and from school. Learner is pregnant. The ID (GUID) of the LearnerPersonal record for this sibling. The Unique Internal Pupil Number for a sibling of this learner. Learner is paid a uniform allowance. The ID (GUID) of the LearnerSchoolEnrolment record associated with this learner that is also designated as the current or current main enrolment. The type of this enrolment as it relates to the school identified by SchoolInfoRefId. Establishment Number for this school School's name as indicated on the Annual Schools Census. The 3-digit LA number assigned by DfES. The date the learner entered this school or establishment. The date the learner exited this school or establishment. Code indicating the type of exit from this school or establishment. An indication of whether the described school or establishment was the last establishment the learner attended. Note that it is possible that more than one establishment can be marked as LastSchool when a learner is enroled in more than one school simultaneously. The ID (GUID) of the learner. Note that this GUID may be the same one assigned to this person when this person is either a contact (ContactPersonal) or a member of the workforce (WorkforcePersonal). This object defines information related to a learner's enrolment within a particular school or establishment.The current status on an enrolment is based on EntryDate and ExitDate. Future enrolments are supported where EntryDate is in the future. ExitDate may also be specified as a future occurance. The date from when this enrolment is valid. The year group in which the learner is taught for the majority of their time, regardless of their chronological age. Indicates if the learner is in a nursery class. Must be set to 'O' if age on August 31 is >= 6. The ending date of this enrolment. If the learner has exited before the end of the school year, ExitDate must have a value. Code indicating the type of exit for this enrolment. Code indicating the destination type. The LA number for destination school or college. The DfES number for destination school or college. Name of institution/employer of learner's destination. Number of learner sessions (half days) per week. A maximum of 10 is possible per week. An indication of whether the learner is enroled only part time. Indicates whether the learner is a boarder at the school or not. Reason for alternative tuition. Beginning date for alternative tuition. End date for alternative tuition. The total number of hours provided for with the tuition. Alternative tuition provision type. The ID (GUID) that uniquely identifies a particular enrolment. The ID (GUID) of the learner to whom this information is linked. The ID (GUID) of the school to which this enrolment applies. The type of this enrolment as it relates to the school identified by SchoolInfoRefId. This object contains information regarding a special education need (SEN) for a learner when provisioned within a school or establishment. A new object exists for each provision. The current status of any provision can be determined by querying StartDate and EndDate. Both dates are allowed to be in the future. The publisher of this object must support queries on these dates. Is this learner with special education needs (SEN) in a mainstream school a member of an SEN Unit (sometimes called special class)? Is this learner with special education needs (SEN) in a mainstream school a member of a resourced provision? Date of learner's next SEN review. A provision (stage) accommodated for this learner within this school. Date when learner was placed on the current SEN stage. Date may be in the future. Date when learner finished this SEN stage. Assumed to be current unless a date in the past is specified here. The code for a Special Educational Need (type) for this learner. A value (starting at 1) indicating the order of significance of special educational need in relation to other SEN types listed here. Level of provision for Advice and Assessment. (Wales) Level of provision for Grouping and Support. (Wales) Level of provision for Specialised Resources. (Wales) Level of provision for Curriculum and Teaching Methods. (Wales) Provision of Embedded Basic Skills support beyond the attainment of formal qualification. Level of literacy at start of this SEN stage. (Wales) Level of literacy achieved by the end of this SEN stage. (Wales) Level of numeracy at start of this SEN stage. (Wales) Level of numeracy achieved by the end of this SEN stage. (Wales) How is the National Curriculum used for this learner? Modified Disapplied National Curriculum subject(s) for which modification or disapplication applies. Is there medical information on this Learner? Type of therapy needed by Learner. Physiotherapy Speech Therapy Occupational Therapy Summary of learner's medical condition. The ID (GUID) that uniquely identifies a learner special need (provision). The ID (GUID) of the learner with special educational needs. The ID (GUID) that uniquely identifies the school provisioned to work with the learner's special needs. This object either contains or references a person's picture. Compare with US/Canada objects: The name of a "personal" object that can be requested for this person using the specified PersonRefId. 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 (URL or JPEG). Can the picture be published? This is the GUID of the person whose picture this is. It is important to note that using the same GUID a person may have a LearnerPersonal record, a WorkforcePersonal record, and a ContactPersonal record all at the same time. This same picture is applicable regardless of the associated object type(s). This object describes a high-level course or class grouping organised and/or taught within a school or establishment. Note that not all courses are based upon a subject area. One such course is "Class Group" which is the same as a homeroom or registration group. Compare with US/Canada object: The school defined local code for the group (or course). Title associated with this group. Textual description for the group. Subject matter areas taught as part of the course, if any. The GUID that uniquely identifies a school course. The ID (GUID) that references the school or establishment where the course is offered or the registration group exists. School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g. 2007 for the 2006/07 school year). Where a group membership is valid across multiple years, the current year at the time of publication will be used. The group type. Teaching groups are used to teach subjects while other groups are organised for various other reasons. Generic Group Registration/Class Group Teaching (course) Group This object describes a specific group and includes resource and time tabling information. All groups are based upon a SchoolGroupType record. However, there are courses which are not based upon any subject area and likewise may not have any teachers or other staff assigned. Compare with US/Canada object: The name associated with this group for display purposes. A textual description. The parent group associated with this group, if any. The role associated with this person in the context of this group. The ID (GUID) of a teacher, staff member, or other employee participating in a non-learner capacity within this group. The ID (GUID) that uniquely identifies this group entity. The ID (GUID) that identifies a course upon which this group is centered. Note that this element is mandatory when GroupType is associated with a course (teaching group). School year for which the group is applicable, expressed as the four-digit year in which the school year ends (e.g. 2007 for the 2006/07 school year). Where a group membership is valid across multiple years, the current year at the time of publication will be used. This object contains basic information about a school or other educational establishment. Compare with US/Canada object with the same name. An ID assigned by the publishing agent for this school or establishment. This may be set to any value. School's name as indicated on the Annual Schools Census. School's full name as stated in the Instrument of Government. School Unique Reference Number. This number is an alternate to the Establishment Number. URL for the school. The school's published address. Other addresses associated with the school. The main phone number for this school/establishment. A list of the school's phone numbers. School's email address for general correspondence. A list of contacts at the school. The name of the head Teacher. The official title of the Head Teacher. The high level code indicating the level of the educational institution. An indication of the level of the educational institution. Governance afforded to this school. Intake type. Comprehensive Selective (Grammar) Secondary Modern Selective (Technical) Religious School Collection of National Curriculum Year Groups offered in this school or establishment. Gender of learners allowed for entry to school. Coeducational Female only Male only Gender of learners allowed for entry to Sixth Form. Coeducational Female only Male only Indicates whether the school supports boarders or not. The number of sessions in the usual school day (usually two). Indicates whether the school maintains a nursery class or not. Must be NO if Phase is set to MP, MS or SY. Must be YES if Phase is set to NY or EY. Indicates whether the school has a special class/unit or not. Must be Yes if Phase = SP. Any details will be stored in the associated SchoolInfoDetail object. Operational condition of a school. The GUID that identifies this school. The ID (GUID) assigned to the LA of which this school is a member. This object provides information about a term; i.e., a reportable period of time. Compare with US/Canada object: Starting date of the term. Ending date of the term. Text-based description of the term. Locally-defined code. Use 'AUT', 'SPR', or 'SUM' for a 3 term year. Otherwise specify the term number within the year. The number of terms in a given year (3-6). Does this TermInfo represent a marking period? Does this TermInfo represent a scheduling term? Does this TermInfo represent an attendance term? The ID (GUID) that uniquely identifies this TermInfo entity. The ID (GUID) that identifies the school where the term is used. This object contains key personal information relating to a workforce member, who might be a teacher or other employee of the school or LA. Compare with US/Canada objects: This is an alert message that is associated with the person. This attribute specifies what type of alert message this is. Medical alert associated with the person. The level of severity of this medical alert. The DfES Teacher Reference number. For those who have one this is a unique number. National Insurance Number. Do not specify temporary numbers. Format: AAnnnnnnA The DfES assigned number for the LA in which the workforce member is working, if associated. The DfES assigned number for the school or establishment in which the workforce member is working. Note that the school may not necessarily be in the same LA listed as the LAId. The post assigned to the workforce member in the context of the school or LA. The ID (GUID) of the workforce member. Note that the same GUID may be assigned to this person when they are also a learner (via LearnerPersonal) and/or a contact (via ContactPersonal). Object to represent a behaviour incident at an educational establishment The ID (GUID) of the school that the event takes place. An indicator of the positive / Negative nature and severity of behaviour Agreed Classification for this behaviour type Free text string to precisely define the type of behaviour (if classification is Other then sub classification is mandatory else optional) Date and time Incident took place (started to take place) How long incident lasted (minutes) The Location the Incident (mostly) took place free text comments about the incident A Preceding LearnerBehaviourIncidentRefID to which this behaviour is linked May indicate the type of persons that this should be displayed to The capacity of Involvement free text comments about the individuals Involvement In the incident The REFID of the member of Staff The capacity of Involvement free text comments about the individuals Involvement In the incident Any recorded Motivation for participation The classification Of Outcome Free text string to precisely define the action (if classification is Other then sub classification is mandatory else optional) Date and time Action has or Will take place The PersonRefId of the person (student/ Employee/ parent) who will carry out the action free text comments about the Action The REFID of the learner The ID (GUID) that uniquely identifies a particular incident Scope of this timetable, ie: a general description of what dates the timetable covers, etc A short label for reference in screen displays. The supplier of the software that created this message A URL to a page on the supplier’s website that gives information about the transfer and/or contact details for the supplier. The product that created this message The version of that Product The unique school ID, taken from the existing SchoolInfo object (requested from ZIS) The school name in plain text – to help a person to see immediately this is the correct school Date schedule was created or last edited (omitted for "Basic data only" message) Name given to schedule by timetabler. The TT-Software may contain more than one schedule, so this tells us which one is being sent. First day of the timetable Last day of the timetable The "Status" of the timetable transfer 'BT' and 'ET' are sent by TTSoftware when sending a timetable. The others are sent by the MIS after receiving a timetable. (See also "Reasons for Status" below). Beginning of transfer. End of transfer. Received but import pending. Successful import. Unsuccessful import. The supplier's phone number(s). Unique GUID for this Timetable transfer A teacher (or teaching post) used on the timetable. This may or may not be a "real" teacher stored in the MIS yet. Unique Code local to TT-Software (could be Teacher Initials, Staff Code, etc) If this teacher is known to the MIS, this is the "WorkforcePersonalId" This is the description of the teacher (or "post", etc). It may be a name "John Smith" or it may just be a description such as "New Maths Teacher". If WorkforcePersonalId is not supplied, this Description is used by the MIS to help theuser manually match to a teacher in the MIS (or decide on some other appropriate action). Unique GUID for this Timetable Teacher A subject used on the timetable. This may or may not be a subject stored in the MIS yet. Unique Code local to TT-Software (could be Teacher Initials, Staff Code, etc) This is the description of the subject (long name) A room (or learning space) used on the timetable. This may or may not be a "real" room stored in the MIS yet. Unique Code local to TT-Software (short name) This is the description of the room (long name) It is used by the MIS to help the user manually match to a room in the MIS (or decide on some other appropriate action). Which "site" this room is on. It may also be used by the MIS. References the TTSite object. A site used on the timetable. This may or may not be a “real” site stored in the MIS yet. Unique Code local to TT-Software This is the description of the site. It is used by the MIS to help the user manually match to a site in the MIS (or decide on some other appropriate action). What "type" of site this is. It is used by the MIS to help with any manual matching. a site on your school virtual (ie: not a physical site) an external site (eg: another school in a federation, or a local business) Unique GUID for this Site The timetable cycle A label for this cycle Number of days in cycle (Max) Number of periods per day (see Rectangular Grid Representation above) A unique local ID for this day A short day label A long day label The day’s position in the cycle (1,2,3,etc). Unique GUID for this cycle A Teaching Group A short free-format label that describes the group. Used for display purposes in the MIS or TT-Software. A longer label to help office staff understand the meaning of the group Subject being taught - see TTSubject NB: We do not allow a TG to have no subject Set number (typically 1,2,3,etc or A,B,C, etc but could be a longer label). Can be useful when office staff are trying to "recognise" a TG Block number or letter (eg: "A") Can be useful when office staff are trying to "recognise" a TG Level / Assessment Stage, eg "KS3" (if known / relevant) The main teacher / supervisor / etc for this group (for reporting / recognition purposes) (see TTTeacher) The teacher (see TTTeacher) The teacher’s relationship with the TG Assistant Head-of-Dept/Subject-Leader other/unspecified Unique local ID A representation of the Curriculum Diagram. A free-format label that describes the junction. Used for display purposes in the MIS and/or TT-Software. A shorter version of Label, for display purposes. An optional way for the TT-Software to provide information about the "type" of junction (eg: "band" or "block") Conditional and has only one value: "SC". "SC" has special meaning – it means this is the top of the "tree" and the input is the whole school. School If Type != "SC", this is the LocalId of another junction output "TG" has special meaning – it means this is the bottom of the "tree" and the output is a TeachingGroup. "YR" means a year (or "principal division") within the school (7,8,9,etc). TeachingGroup Year Other Groups An optional way for the TT-Software to provide information about the "type" of junction (eg: "band" or "block"). Unique LocalID of this junction output If Type = "TG" then include here the TeachingGroupID (see TeachingGroup) Description. Required if Type is not "TG". Optional if Type is “TG” (since a TG has its own ShortName and LongName already) A shorter version of Desc, for display purposes NC Year Group A unique local identifier for this junction A "non-teaching activity" is used to represent times when a teacher is not teaching a Teaching Group but is nonetheless "busy". Examples are meetings, part-time teachers who are not in school, PPA time, etc. A unique code for the non-teaching activity A description of the non-teaching activity Lesson/meeting type Note this Type over-rides the period type in the cycle definition (in case, for eg, Period 1 is Registration for some classes but not others) registration break lunch outside school hours (eg: clubs) teacher unavailable (but in school) teacher unavailable (out of school) other (or unspecified) non-teaching A unique local identifier for this junction A lesson on the timetable Day this lesson is scheduled Index of period this lesson/meeting starts Lesson/meeting type The value here determines whether a TeachingGroupID or an NTCode is required teaching non-teaching Length of lesson in periods (1=single, 2=double, etc). Can omit if just a single. The Teaching Group being taught (may not be one if Type != "T") (see TeachingGroup) If there is no TeachingGroupRefID (see NTCode) The teacher(s) teaching / supervising this lesson (see TTTeacher) The room (or location) where this lesson is taking place (see TTRoom) The ID (GUID) of the learner to whom this entitlement is linked. The ID (GUID) of the school to which this entitlement applies. The type of this Entitlement Date Specific Entitlement starts Date Specific Entitlement Ends has to be on or after Start date A note relating to entitlement period The LA or Provider identifier of awarding organisation if relevant The ID (GUID) that uniquely identifies a particular entitlement. The ID (GUID) of the person to whom the Dietary preference is linked. Date Specific pattern starts Date Specific pattern Ends. A note relating to pattern The Day of week that Meal is required Which meal of the day is required What type of meal is required The Type of preference The component of meal A note relating to dietary preference Should the Meal component be Included or Excluded from the meal. Default is Exclude Object to determine school days, non school days or any "special arrangement" days The ID (GUID) of the school to which this MealStatus applies. The status of the school on a particular date; e.g., Status for staff; Y/N, Status for pupils Y/N AM or PM The ID (GUID) that uniquely identifies a particular MealStatus reference Details the absence of a Workforce person for a duration and reason. If the reason is sickness then additional detail can be provided in line with typical HR requirements. If the absence only relates to a specific assignment, e.g. an individual who is a kitchen assistant and midday supervisor takes the morning off only then this association can be made. Date this absence started. Time on AbsenceStartDate that this absence started, assumed midnight if not included. Date this absence ended, if omitted it is assumed that the absence is ongoing. Time on AbsenceEndDate that this absence ended, assumed midnight if not included. Type of absence. Specific illness if AbsenceType is Sickness. For use if this absence relates to a specific WorkforceAssignment. The ID (GUID) of the WorkforceAbsence object. RefId of WorkforcePersonal object this applies to. Extends the details specified in a WorkforceAssignment to include details of contracts governing WorkforceAssignments. This is a stub only at the moment and may be expanded in the future to contain additional contract details such as renumeration. Based around the US SIF 2.4 EmployeeContract object. Date this contract becomes effective. Date this contract ceases effect. Reference identifying this contract and assignment. Employed hours per week on this contract. Employed weeks per year on this contract. 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).