SIF Student Locator API documentation version v3.3.0
https://sif3service.dev/v3.3.0/svcs/dev/requestProvider/
Overview
The Student Locator service is used to find a specific student in a SIF 3.x system when the refId of the student object is unknown. The primary use case is for use within the SIF Student Record Exchange, where it is used to find a student so that the records of that student can be requested for transfer.
Search for a single student
This is a request to a provider to return the targets and IDs for the students within the domain indicated by the identifying elements. The provider returns one Match marked Valid
, or one or more Matches marked Ambiguous
, or indicates an error. The results include basic information about the matching student, as well as a set of links to other objects or relevant services. In this way, the Student Locator becomes a starting point for interacting with the student's data elsewhere in the SIF infrastructure.
This action executes a standard SIF Static Named XQuery, which must be registered in the zone's Named XQuery Registry with the xqueryToken
set to studentLocatorSearch
. This named query template specifies the parameters that can be combined together to execute a potentially complex search for student records. The provider may use these parameters to conduct a probabilistic search with a complex algorithm that tweaks parameters or uses artificial intelligence to deliver the best possible search result.
All parameters in this search are optional, but consumers should provide as much information as possible to get the best result.
Search for a group of students
Used for finding large groups of known students e.g., for student recovery (“Where did these 10,000 students end up?”)
For future use.