...
The GET service will return all attributes you have access too, the options are the "GetPeopleService" and the "LimitedPeopleService", see the service contracts below for details. The LimitedPeopleService contains less attributes, but the more generic ones. Note: An enhancement was deployed to Production in June 2019 to enable filtering on GetPeopleService click this link for details: PeopleService Version Notes 1.3
The POST service will enable you to pass parameters listed below and in the PeopleService contract. This gives you some flexibility in datasets and in attributes returned.
...
https://gw.its.yale.edu/soa-gateway/PeopleHub/v1/LimitedPeopleService
Making Requests (POST-only):
GET method requests will default to the "Get All Data" message listed in the example requests.
...
Population Filters- Please use Service Contract to get details PeopleService_v1.xlsx
Include Future: pass query parameter of ?includefuture=Y at the end of your endpoint. See Details here: Release Version Notes 1.1
Example Requests:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<Request>
<AttributeFilter>
<Contact>Y</Contact>
<Demographic>Y</Demographic>
<Position>Y</Position>
<Appointment>Y</Appointment>
<Enrollment>Y</Enrollment>
<Organization>Y</Organization>
<Status>Y</Status>
</AttributeFilter>
<PopulationFilter>
<Operator>OR</Operator>
<Primary_EDU_Person_Affiliation cmp="IN"> </Primary_EDU_Person_Affiliation>
<Primary_Yale_Relationship cmp="IN"> </Primary_Yale_Relationship>
<Has_Affiliate_Role cmp="EQUALS"></Has_Affiliate_Role>
<Has_Employee_Role cmp="EQUALS"> </Has_Employee_Role>
<Has_Faculty_Role cmp="EQUALS"> </Has_Faculty_Role>
<Has_Student_Role cmp="EQUALS"> </Has_Student_Role>
<Has_Member_Role cmp="EQUALS"> </Has_Member_Role>
<Has_Staff_Role cmp="EQUALS"> </Has_Staff_Role>
<Student_Status cmp="IN"></Student_Status>
<Worker_Status cmp="IN"> </Worker_Status>
<Cost_Center_Code cmp="IN"> </Cost_Center_Code>
<Department_Code cmp="IN"> </Department_Code>
<Planning_Unit_Code cmp="IN"> </Planning_Unit_Code>
</PopulationFilter>
</Request> |
...