SearchByIndividual Service Making Requests
- Marissa Kitz (Unlicensed)
- Christine Viele
Data Source: People Hub
This service will return the same response as the PeopleService, but it is a GET request for either 1 individual if searching by netid, upi, idcard, proxnumber or a small subset if searching by name parameters.
NOTE: If your service account does not have access to id card number and prox number you cannot filter by those identifiers. Parameters are limited to fields of access.
SearchByIndividual Service Contract: SearchbyIndividual_v1.xlsx
For XML Parsing please see these notes: XML Parsing
Example SOAPUI Project: SearchByIndividual-soapui-project.xml
Endpoints:
Test:
https://gw-tst.its.yale.edu/soa-gateway/PeopleHub/v1/SearchByIndividual?
Production:
https://gw.its.yale.edu/soa-gateway/PeopleHub/v1/SearchByIndividual?
Parameters: These can be added in any amount, all can be used, just one, or any combination of them. However, at least 1 parameter value must be used for this service. In order to use "roles" you must use it with an identifier parameter, like name. To use multiple parameters place "&" in between the parameter names.
netid=
upi=
firstname= (Partial or full names are allowed, if partial name it must be the first portion of the name)
lastname= (Partial or full names are allowed, if partial name it must be the first portion of the name)
idcard=
proxnumber=
role= View service contract for details on valid entries
outputformat= (enter xml or json), if no output format is defined, it will default to xml
Examples:
https://gw-tst.its.yale.edu/soa-gateway/PeopleHub/v1/SearchByIndividual?netid=sl2393
Related articles