Single PersonID Secure call
For development the root of the API is at:
https://staging.connects.catalyst.harvard.edu/API/Profiles/Public/ProfilesDataAPI/ . It's currently on our staging server, but returning production data, we will be moving it to our production server soon, with a new URL. We will update you when we make this change. There will likely be some additional functionality added soon like the data for twitter feeds, youtube, slideshare and media/urls shared by faculty. Currently the API is purely restful, and only allows https/http get requests, this limits the requests somewhat, not allowing particularly complex searches. Upcoming versions will have POST requests with additional capability to ensure that this API has all the functionality of our older APIs. We will add JSON format as soon as we update our database servers to SQL 2016 hopefully this year.
If they navigate to the API endpoint, it will give you the following details:
Profiles Data API
To use the Profiles Data API call: /getPeople/{format}/{param name}/{param value}/{param name}/{param value}
Supported Formats: xml
Parameters:
PersonIDs: comma separated list of personIDs OR
Institution: limit results to users from this institution (default all users) Department: limit results to users from this department (default all users) Division: limit results to users from this division (default all users) FacultyRank: limit results to users with this faculty rank (default all users) Keyword: limit results to users with connected to this searh term, ordered by connection strength (default all users) PLUS
Count: maximum number of people to return (default all users) Offset: offset to allow for pagination of results (default 0) Columns: comma separated list of data to return, currently supported columns are address, affiliation, overview, publications, concepts Years: only return publications from these years. Acceptable formats are comma separated (2017,2018,2019) or a range (2017-2019). (default all years)
In addition to this, for authorized users, we have added a secure Key parameter and HUIDList as a parameter, and HUID as a supported column. HUIDList is a comma separated list of HUIDs. You must specify a valid key to use HUIDList, otherwise you will get no results back. You must have a valid key to request the HUID column, otherwise you will just get the regular data with no HUID back. If you want the HUID returned, you need to use the columns option and specify all the columns that you want. This means that as we add new data, you will need to change your code to request the new columns. In the future we hope to improve this, so you can request default columns plus HUID.