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.
Service Contract:
Data Source: People Hub
This service queries the People Hub dbo.YUPH_PEOPLE_GENERAL_HIST_RSET_V view and returns all records in that view or top of stack for the date(s) specified depending on the parameters sent.
The response includes the same fields as the PeopleService and as allowed for the Service Account making the request with one addition:
<Validity>
<StartDate></StartDate>
<EndDate></EndDate>
</Validity>
GetChangesService Contract: GetChangesService_v1.xlsx
For XML Parsing please see these notes: XML Parsing
Response XSD: ChangesService_Response_v1.xsd
Example SOAPUI Project: Coming Soon
Endpoints:
Dev (Less stable (ongoing build process), can use for failure testing, or getting queries correct):
Test (Preferred Endpoint, more stable):
Production (Not Available until Workday R4 Go-Live July 1 2017):
...
Test:
https://gw-tst.its.yale.edu/soa-gateway/PeopleHub/v1/GetChangesService
Production:
https://gw.its.yale.edu/soa-gateway/PeopleHub/v1/GetChangesService
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 namesparameters. See service contract for details.
netidpagenumber=
upirecordsperpage=
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
changestartdate=
changetodate=
showallchanges=
Examples:
https://gw-tst.its.yale.edu/soa-gateway/PeopleHub/v1/SearchByIndividualGetChangesService?lastnamepagenumber=Young1&firstnamerecordsperpage=Br100&outputformat=xml
https://gw-tst.its.yale.edu/soa-gateway/PeopleHub/v1/SearchByIndividualGetChangesService?lastnamepagenumber=Young1&firstnamerecordsperpage=Br100&outputformat=json changestartdate=2017-04-27
https://gw-tst.its.yale.edu/soa-gateway/PeopleHub/v1/SearchByIndividual?netid=sl2393
GetChangesService?pagenumber=1&recordsperpage=200&showallchanges=N
Related articles
Filter by label (Content by label) | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|