Investigate using new CAP/Profiles API enhancements

[mjgiarlo]

See the announcement and linked documents below for details:

Following up on the notification of the release of the new Stanford Profiles CAP API features on Sept. 24, 2018, I am attaching some documentation regarding these new features for those of you who support and develop sites that are integrated with the CAP API or are considering integration.

To summarize, the Stanford Profiles development team has enhanced the API, based on feedback from consumers of the API, to add features which allow end users of the API to control the amount of data that is returned in the profiles returned from the API and / or the number of profiles that are returned in the API.

The new features are:

whitelist - Comma delimited list of attributes to return in the profile json (instead of the full profile json).

filter - Comma delimited list of filters which will return back the profile(s) json but with the arrays within filtered based on the criteria specified. CAP API users can filter out the arrays in any JSON document. For example, only getting back publications that are featured instead of all publications for a profile.

where clause - Comma delimited list of whereClauses which will return back the profile(s) json that match the whereClause criteria specified. Where clauses return back documents (profile, org etc) that match the criteria, which means the total number of entries returned back can differ.

Stanford Profiles - CAP API Filtering - 10-2-2018.pdf
Stanford Profiles - CAP API Documentation 10-2-2018.pdf