Qodex.ai

RESTful XML PersonDataAPI

Number of APIs: 6

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 seperated list of personIDs

OR/AND use the following URL parameter names

  • 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 search term, ordered by connection strength (default all users)

Pagination, Columns, Publication date ranges.

  • 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)

  1. Single PersonID GET https://connects.catalyst.harvard.edu/API/Profiles/Public/ProfilesDataAPI/getPeople/xml/PersonIDs/32213/columns/all

  2. List of PersonID GET https://connects.catalyst.harvard.edu/API/Profiles/Public/ProfilesDataAPI/getPeople/xml/PersonIDs/45195,32231,55724/columns/all

  3. Institution GET https://connects.catalyst.harvard.edu/API/Profiles/Public/ProfilesDataAPI/getpeople/Institution/beth%20israel%20deaconess%20medical%20center/columns/all

  4. Institution and Department GET https://connects.catalyst.harvard.edu/API/Profiles/Public/ProfilesDataAPI/getpeople/Institution/beth%20israel%20deaconess%20medical%20center/department/Neurosurgery/columns/all

  5. Institution and MeSH Concept GET https://connects.catalyst.harvard.edu/API/Profiles/Public/ProfilesDataAPI/getpeople/Institution/beth%20israel%20deaconess%20medical%20center/keyword/Myocardial Infarction/columns/all

  6. Single PersonID Secure call GET http://connects.catalyst.harvard.edu/API/Profiles/Public/ProfilesDataAPI/getPeople/xml/PersonIds/14998/Columns/huid,address,awards,education,affiliation,overview,publications,/key/{API-KEY}