| | StudentLocator | | 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.
| |
| @ | RefId | M | 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. | RefIdType |
| @ | IdStatus | M | 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.
| values:
- Request
- This is a request to the state for an Id. The StateProvinceId element may not necessarily be blank—if the requesting agency believes they know the student's state-assigned Id, StateProvinceId can be pre-filled for validation by the state.
- Release
- Some states require notification when a student leaves the district. This request, accompanied by a valid StateProvinceId, instructs the state to release the binding between this student and the LEA.. The response should also be qualified "Release."
- Valid
- Marks a response from the state with a valid StateProvinceId. If the Request included a StateProvinceId, the value of StateProvinceId in the response could be different.
- Ambiguous
- Marks a response where the state couldn't uniquely identify the student based on the information provided. The state may respond to the request with a single StudentLocator object marked "Ambiguous" and an empty StateProvinceId. Alternatively, if the district agent supports it, the state response may include one or more StudentLocator objects with candidate matches. Each of these objects would be marked "Ambiguous," and populated per the particular state's policies. StateProvinceId need not be empty in these objects.
- Resolve
- If the state and district choose to resolve ambiguities via StudentLocator, the district might follow up an "Ambiguous" response that included match candidate(s) with a "Resolve" request populated with the information from the match candidate selected by the district.
- New
- If the state and district choose to resolve ambiguities via StudentLocator, the district might follow up an "Ambiguous" response that included match candidate(s) with a request marked "New" to notify the state that none of the match candidates is appropriate and a new state-assigned Id should be created.
- Cancel
-
A district can cancel a StudentLocator transaction in progress as follows:
The requester issues a SIF_Request where IdStatus is set to Cancel and @TransactionId is set to the
GUID of a previous transaction. This instructs the responder to cancel that transaction in progress.
If successful, the responder replies with a SIF_Response where IdStatus is set to Cancelled.
If the TransactionId is invalid, the cancel operation was not successful, or an exception occurred,
the responder replies with a SIF_Response where IdStatus is set to Error and the SIF_Error element
describes the error.
Both sides consider the transaction cancelled.
- Cancelled
-
A state can inform a district that it has cancelled a
StudentLocator
transaction as follows:
The responder (typically state) replies to a prior
SIF_Request
with a SIF_Response where IdStatus is Cancelled.
This informs the requester (typically district) that the transaction has been cancelled for whatever reason
(usually at the direction of state administrative staff through some application user interface). The transaction ends.
- Error
-
When IdStatus is set to Error, the SIF_Error element provides details about the error.
|
| @ | TransactionId | M |
GUID that allows requesters and responders to refer to the same logical StudentLocator "transaction" over more than one
SIF_Request/SIF_Response exchange.
| GUIDType |
| | StateProvinceId | M | 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. | StateProvinceId |
| | Confidence | O | 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. | xs:normalizedString |
| | LocalId | O | 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. | LocalId |
| | StudentPersonalRefId | O | 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. | IdRefType |
| | RequestingAgencyId | OR | 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. | xs:normalizedString |
| @ | Type | M | The functional level of the requesting agency. | values:
- ESA
- Educational Services Agency
- LEA
- Local Educational Agency (District)
- School
|
| | GradeLevel | O | The student's current grade level. | GradeLevel |
| | SSN | O | Social security number of the student. | xs:normalizedString |
| | Name | OR | The name(s) of the student. | Name |
| | Address | OR | The address(es) of the student. | Address |
| | Demographics | O | 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. | Demographics |
| | Contact | OR | Typically used to provide the state information about a student's parents and legal guardians. | |
| | Contact/Relationship | M | Relationship to the student. | Relationship |
| | Contact/Name | OR | The name(s) of the contact. | Name |
| | Contact/OtherId | O | An other Id associated with the contact. | OtherId |
| | Contact/EducationalLevel | O | Highest level of education completed by the contact. | EducationalLevel |
| | EffectiveDate | O | 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. | xs:date |
| | StartDate | O | Begin date for a range that is being requested. Note: In most cases this will correspond to the school entry date. | xs:date |
| | EndDate | O | End date for a range that is being requested. Note: In most cases this will correspond to the school exit date. | xs:date |
| | GraduationDate | O |
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.
| GraduationDate |
| | SchoolAttendedName | O | The name of the school last attended by the student. | xs:normalizedString |
| | SchoolAttendedLocation | O | The location of the school last attended by the student (e.g. city or county name, district name, etc.). | xs:normalizedString |
| | OtherId | O | Additional student identifier not represented elsewhere in StudentLocator (e.g. the driver's license number of the student). | OtherId |
| | SIF_Error | C |
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_Error |
| | SIF_Metadata | O |
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.
| SIF_Metadata |
| | SIF_ExtendedElements | O | | SIF_ExtendedElements |
