People

Get a collection

GET /people HTTP/1.1

Query string parameters

All query string parameters are optional.

callback string

Wraps the response in a callback function of the given name. Use this parameter to facilitate JSONP requests.

channels comma-separated list of IDs

Return people assigned to the given channels.

excluded_ids comma-separated list of IDs

Returns people, except those with the given IDs.

ids comma-separated list of IDs

Return people with the given IDs.

order_by comma-separated list

Sort people by one or more ORDER_BY and ORDER parameter pairs. Options:

• ORDER:
  • asc: order from lowest to highest values
  • desc: order from highest to lowest values
• ORDER_BY:
  • id: order by person ID
  • list: order by the order of IDs given in the ids parameter
  • publish_date: order by publish date
  • score: order by popularity

Format: ORDER_BY|ORDER[,ORDER_BY|ORDER,...]

Default value: last_name|asc

page integer

Return people from a specific page of a collection.

Default value: 1

per_page integer

Number of people to return per page of a collection. Maximum: 100

Default value: 5

type comma-separated list

Return people of a specific type. Options: faculty_expert, media_rep

Response

In the example response, embedded people are truncated for illustrative purposes. In the real-world version of the response, "...person object..." is an entire person resource.

{
   "_embedded": {
      "people": [
         "...person object...",
         "...person object...",
         "...person object...",
         "...person object...",
         "...person object..."
      ]
   },
   "_links": {
      "find": {
         "href": "/people/{?id}",
         "templated": true
      },
      "next": {
         "href": "/people?page=3"
      },
      "prev": {
         "href": "/people?page=1"
      },
      "self": {
         "href": "/people?page=2"
      }
   },
   "page": 1,
   "per_page": 5,
   "return_count": 5,
   "total_available": 100
}

Attributes

_embedded hash

Embedded resources.

Toggle child attributes

_embedded.people[] array

An array of person objects.

_links hash

Links to resources associated with the person collection.

Toggle child attributes

_links.find link object

A templated link that can be used to find a specific resource in the collection.

Toggle child attributes

_links.find.href string

URI of the link.

_links.find.templated boolean

Identifies the href as a templated URI.

_links.next link object

A link to the next set of resources in the collection. If there is not a next page, this link will not be present.

Toggle child attributes

_links.next.href string

URI of the link.

_links.prev link object

A link to the previous set of resources in the collection. If there is not a previous page, this link will not be present.

Toggle child attributes

_links.prev.href string

URI of the link.

_links.self link object

A link that identifies the current resource.

Toggle child attributes

_links.self.href string

URI of the link.

page integer

The page number of the returned collection.

per_page integer

The number of people requested per page.

return_count integer

Number of people returned.

total_available integer

Total number of people available in the collection.

Get one

GET /people/:id HTTP/1.1

Endpoint parameters

id integer required

The unique identifier of the person.

Response

{
   "_embedded": {
      "faculty_expert_affiliations": null,
      "faculty_expert_topics": null,
      "headshot": null
   },
   "_links": {
      "self": {
         "href": "/people/38506"
      }
   },
   "cell_phone": null,
   "email": "aadalja1@jhu.edu",
   "first_name": "Amesh ",
   "id": 38506,
   "last_name": "Adalja",
   "office_phone": null,
   "slug": "amesh-adalja",
   "title": [
      "Assistant Professor, Bloomberg School of Public Health",
      "Senior Scholar, Johns Hopkins University Center for Health Security"
   ],
   "twitter": "@AmeshAA",
   "type": "faculty_expert",
   "url": "https://hub.jhu.edu/experts/profiles/amesh-adalja/"
}

Attributes

_embedded hash

Embedded resources.

Toggle child attributes

_embedded.faculty_expert_affiliations[] array|null

An array of faculty expert affiliations assigned to the person or null if none are assigned.

_embedded.faculty_expert_topics[] array|null

An array of faculty expert topics assigned to the person or null if none are assigned.

_embedded.headshot[] array

An array containing the file assigned as the headshot image of the person or null if not assigned

_links hash

Links to resources associated with the person.

Toggle child attributes

_links.self link object

A link that identifies the current resource.

Toggle child attributes

_links.self.href string

URI of the link.

cell_phone string

email string

first_name string

id integer

Unique identifier of the person.

last_name string

office_phone string

slug string

The last part of the URL that identifies the resource.

title array

An array of titles that describe the person’s job and/or status within Johns Hopkins.

twitter string

The person’s Twitter handle, without the @ prefix.

type string

Type of resource.

url string

Full URL of the person’s profile. Only present faculty_experts types.

Get a subcollection

A subcollection is a collection of objects contained within a person.

GET /people/:id/:subcollection HTTP/1.1

Endpoint parameters

id integer

The unique identifier of the person.

subcollection string

The name of the subcollection to retrieve. Options: articles, or channels

Query string parameters

To filter the subcollection, see the list of available parameters associated with the chosen subcollection:

• articles
• channels

Response

See the response associated with the chosen subcollection:

• articles
• channels