This object contains information on authorities that provide ReportManifest objects and/or collect SIF_ReportObject objects, such as state departments of education, regional service agencies, or other report collecting agencies.

The unique identifier for this agency/report authority.

Name of the agency/report authority.

The zone unique case-sensitive identifier for the authority. This will be the contents of the SIF_SourceId element in the header of requests for reports.

Department, office, or subdivision of the agency/report authority.

Level of the authority.

Information on the contact person in this agency.

This object provides a way to define a report within a SIF zone. It contains metadata about the report. This object represents a mutual agreement between senders and receivers of the report.

Note: With SIF Implementation Specification version 2.4 the choice element depicted in the diagram below has changed. In the XSD files, the choice element used to be rendered as a sequence of optional elements. Now, in the XSD files, the choice element is rendered as an xs:choice. This may cause problems with agents that treat the choice element as two optional elements rather than a choice of one and only one of the choices.

The unique identifier for this report manifest.

Id (GUID) of the authority providing this manifest.

Specifies which SIF Implementation Specification version should be used when returning the report data; wildcards are allowed. When a wildcard is specified, the responding agent SHOULD attempt to return the report data in the version specified by SIF_Message/@Version, if that version matches the wildcard version. If not, the responding agent can return the data in any version it chooses that matches the wildcard version.

Specifies the maximum size of a packet to be returned to the report authority.

The GUID of the authority for whom the report is intended, usually the same authority that defines this manifest.

The name of the object referenced.

The authority's accepted name for the report.

The description for the report.

Information on the period of time over which the report spans.

Indicates where the report definition can be found. If Type is Embedded or Base64Binary, this element's value contains the report definition. If Type is URL, this element's value is the location of the external definition. A Type value of SIF_Query indicates that the SIF_QueryGroup element below contains the definition. A Type value of SIF_ExtendedQuery indicates that the SIF_ExtendedQuery element below contains the definition.

This attribute indicates the source of the report definition.

The vendor-defined query language used in the report definition (e.g. SQL, ExampleObject, Description, com.vendor.format, etc.). If the Type attribute is SIF_Query, then QueryLanguage should also be SIF_Query. If the Type attribute is SIF_ExtendedQuery, then QueryLanguage should also be SIF_ExtendedQuery.

An optional list of one or more third-party formats that describe the visual representation of the report data. If more than one report format is associated with a manifest, the implementation can choose the most applicable format by examining the ContentType attribute.

Parent element containing the querying criteria for extracting the report information if ReportDefinitionSource/@Type is SIF_Query.

Query criteria for extracting the report information if ReportDefinitionSource/@Type is SIF_ExtendedQuery.

This object is an envelope used to send other data objects, typically reports, to authorities such as state departments of education, district offices, other schools, etc. It is also used to signal a data collector agent that a report is compiled and ready to be requested. SIF_ReportObject contains a data object, which is either complete or partial (a partial data object is one that contains a subset of the elements for the data object). One or a series of SIF_ReportObjects contained within one or a series of related SIF_Response messages makes up a complete report.

Note: With SIF Implementation Specification version 2.4 the choice element depicted in the diagram below has changed. In the XSD files, the choice element used to be rendered as a sequence of optional elements. Now, in the XSD files, the choice element is rendered as an xs:choice. This may cause problems with agents that treat the choice element as two optional elements rather than a choice of one and only one of the choices.

The Id (GUID) that uniquely identifies this instance of a report.

Identifies the manifest for the report and characteristics of the submission. This element is a conditional element. This element, the ReportData element, or the SIF_ExtendedQueryResults element is included but never more than one at the same time within an instance of this object. See examples of the usage of the object below.

Container element for the report content; one valid SIF object can occur as a child here. This element is conditional. This element or ReportInfo or SIF_ExtendedQueryResults is included but never at the same time. See examples of the usage of the object below.

The report content resulting from a SIF_ExtendedQuery-based report. This element is conditional. This element or ReportInfo or ReportData is included but never at the same time.

StudentLocator has been upgraded to a set of SIF Zone Services. It is anticipated that the StudentLocator object will be removed from the next major version of this specification.

This object provides a mechanism for requesting and updating state student identifiers. While communicated using SIF's request/response model, this object is an exception case in terms of how it interacts especially with SIF's query mechanisms (e.g. one wouldn't request certain elements be returned from StudentLocator). The use of this object is dictated by external use cases and best practices.

A GUID that identifies an instance of this object. This RefId is a “transient” value; that is, it SHOULD be generated by the provider at the time the object is provided in a Response message. This value MUST NOT be used in a later Request for the object.

Communicates the orchestration status for the object.

Because the Cancel and Cancelled values model application behavior and may not be implemented by all systems that are otherwise capable of supporting StudentLocator objects, they are optional. If the requester (district) receives a Cancelled reply but does not support this functionality, the reply should be ignored without taking further action. If the responder (typically state) receives a Cancel request but does not support this functionality, it should reply with a SIF_Response where the SIF_Response/SIF_Error element is set to indicate an error. The SIF_Category should be set to 8 (Request and Response) and SIF_Code set to 9 (Unsupported query in request). Note: In this case the SIF_Response/SIF_Error element is used per normal SIF request/response protocol; not to be confused with the StudentLocator/SIF_Error element, which is to be used when a student lookup results in a processing error.

GUID that allows requesters and responders to refer to the same logical StudentLocator "transaction" over more than one SIF_Request/SIF_Response exchange.

This is the student's state-assigned Id. May be empty in a response where IdStatus is "Ambiguous."

NOTE: Although used in the context of a Request query, this field conveys information to (and from) the state and typically does not participate in the matching logic.

Confidence score. The main use of this element is when IdStatus equals "Ambiguous" and the state returns one or more* candidate matches. The interpretation is that the information populated in each returned object matches the information in the request to the extent expressed in this score. The matching/scoring algorithms (and resultant values) are defined by the particular state.

States may also choose to use this element for the district to indicate in the query what score threshold it wants associated with the request.

*A response marked "Ambiguous" with a single match candidate populated likely means that the Confidence score is below the state's threshold for assignment but above the threshold for creating a new state-assigned Id.

This is the requesting agency's unique Id for the student.

NOTE: Although used in the context of a Request query, this field conveys information to (and from) the state and typically does not participate in the matching logic.

Requesting agency's local zone GUID of the student's StudentPersonal object.

NOTE: Although used in the context of a Request query, this field conveys information to (and from) the State and typically does not participate in the matching logic.

Identification of the agency and/or location requesting the state Id. Optional because the SIF Zone infrastructure may provide adequate information for the state to ascertain the origin of the request.

NOTE: Although used in the context of a Request query, this field conveys information to the state and typically does not participate in the matching logic.

The functional level of the requesting agency.

The student's current grade level.

Social security number of the student.

The name(s) of the student.

The address(es) of the student.

Demographic information about the student. This will typically be the core matching information. Privacy considerations may mean that it is filled differently here than it might be in a local StudentPersonal, but it must include enough to drive the state's matching algorithms.

Typically used to provide the state information about a student's parents and legal guardians.

For Requests, this should match StudentSchoolEnrollment/EntryDate.

For Releases, StudentSchoolEnrollment/ExitDate.

NOTE: Although used in the context of a Request query, this field conveys information to the state and typically does not participate in the matching logic.

Indicates the date the student graduated—Year, Year and Month, or Year, Month and Day may be specified. Intended to facilitate locating students that may not be currently enrolled in a school or district, particularly in the context of locating student identifiers for initiating a request for a student's academic record. Supplied date values may often be approximations made by the entity endeavoring to request a student's academic record.

The name of the school last attended by the student.

The location of the school last attended by the student (e.g. city or county name, district name, etc.).

Additional student identifier not represented elsewhere in StudentLocator (e.g. the driver's license number of the student).

When IdStatus is set to Error, this element provides details about the error. Rather than the specification defining a list of possible error categories and codes for StudentLocator transactions, the SIF_Category and SIF_Code elements may contain values defined by the application that is responding to the StudentLocator request. It is recommended the requester convey these values in log files or error reports, along with the SIF_Desc and optional SIF_ExtendedDesc elements.

SIF_Metadata/TimeElement may be specified as metadata of a StudentLocator SIF_Request to indicate a time duration to which the request parameters apply (as opposed to adding new elements to the StudentLocator object). This metadata may be supplied by systems that know a student existed in a district during a certain time period (e.g. a system initiating a student record exchange). If the responder is able to make use of the metadata, it may do so to narrow down the student look-up; otherwise the metadata can be ignored or logged.