Person With Relationships

Description

The Person with Relationships query is used to query for a person and all the relationships of the person.

This query supports the person parameter as the ID for the person in the query. The person parameter is required.

Data Formats

If you make a GET request, specify the data format using the Accept header.

If you POST something, specify the media type using the Content-Type header.

Parameters

Name Type Description
Authorization header The authorization carrying the OAuth 2.0 access token. See OAuth 2.0 Bearer Tokens.
persons query Specifies that in addition to the person and that person's relationships, the spouses, parents, and children of the person should be included in the response.
person query The id of the person being queried.
access_token query The ID of the OAuth 2 access token used for identification and authorization of the user (and agent) making the request.

Operations

GET - Query for a person and associated relationships.

Status Codes
200 The query was successful.
301 If the person has been merged into another person.
404 If the person is not found.
410 If the person has been deleted.
429 If the request was throttled.

POST - Update a person.

Status Codes
303 A successful update will redirect the update to the Person resource.

DELETE - Delete a person.

Status Codes
303 A successful delete will redirect the update to the Person resource.

Example Requests

Read Person With Relationships How to query for a person and the person's relationships.