Ancestry

Description

The Ancestry query is used to query the application for an ascending pedigree rooted at a person and for a specific number of generations. The result of the query is a list of persons. Each person comes with an ascendancy number in the display properties for the person. The ascendancy number is interpreted as an ahnen number that determines the position of each person in the pedigree.

Note:

  • The person parameter is the ID for the person at the root of the pedigree. The person parameter is required. The ancestor number of the person identified by the person parameter will be 1, unless the spouse parameter is provided.
  • The presence of the spouse parameter indicates that the pedigree of both the person and the person's spouse is requested. When the spouse parameter is supplied, the ascendancy number of the person and the spouse is either 2 or 3, depending on the role of the person.
    • If the value of the spouse parameter is empty, the application may select a spouse for the person.
    • Otherwise, the value of the spouse parameter is interpreted as the ID of the spouse selected for the pedigree.

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.
spouse query If provided, the ancestry of the spouse will be included. An empty value indicates the system will choose a spouse. A value of "UNKNOWN" indicates the system will select the "unknown spouse" for purposes of drawing the pedigree.
personDetails query When the query parameter is supplied then additional person details will be returned for each person in the ancestry.
generations query The number of generations being queried. The max generations is 8.
descendants query When the query parameter is supplied then additional details will be returned for each descendant in the ancestry.
marriageDetails query When the query parameter is supplied then marriage details will be returned for each person in the ancestry.
person query The ID of the person whose ancestry is 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 the ancestors of a person for a number of generations.

Status Codes
200 The query was successful.
301 If the requested person has been merged to another person.
410 If the requested person has been deleted.
429 If the request was throttled.

Example Requests

Read Person Ancestry How to read the ancestry graph for a person.
Read Person Ancestry and additional person details How to read the ancestry for a person and return additional person details.
Read Person Ancestry with Specified Spouse How to read the ancestry graph for a person with a specified spouse.
Read Person Ancestry with Specified Spouse and additional person and marriage details How to read the ancestry graph for a person with a specified spouse and return additional person details and marriage details.