Descendancy

Description

The descendancy query is used to query the application for a descending pedigree rooted at a person and for a specific number of generations. The result of the query provides a list of persons. Each person will supply a descendancy number in the display properties for the person. The descendancy number is interpreted as a d'Aboville number which can be used to determine the position of each person in the descendancy.

The descendancy query may support the inclusion of the spouses of each person in the descendancy graph. Spouses returned in the query will also have a descendancy number, but the descendancy number will have a -S appended to indicate the role of spouse.

Note:

  • The person parameter is the ID for the person at the root of the descendancy. The person parameter is required. The descendancy number of the person identified by the person parameter is 1.
  • The presence of the spouse parameter indicates that the descendancy is narrowed to a specific spouse. When the spouse parameter is supplied, the descendancy number of both the person and the spouse will be 1 (the spouse will have a "-S" appended to the number).
    • If the value of the spouse parameter is empty, the application will return the descendancy of a person narrowed to the "unknown" spouse.
    • Otherwise the value of the spouse parameter is interpreted as the ID of the spouse selected for the descendancy.

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 descendancy will be narrowed to a specific spouse. If not provided, the system will select a spouse. An empty value indicates the system will select the "unknown" spouse.
personDetails query When the query parameter is supplied then additional person details will be returned for each person in the descendancy.
generations query The number of generations being queried. The max generations is 2.
marriageDetails query When the query parameter is supplied then marriage details will be returned for each person in the descendancy.
person query The id of the person whose descendancy 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 descendants of the 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 Descendancy How to get the descendancy for a person.
Read Person Descendancy and additional person and marriage details How to get the descendancy for a person and return additional person details and marriage details.
Read Person Descendancy with Specified Spouse How to get the descendancy for a person with a specified spouse.
Read Person Descendancy with Specified Spouse and additional person and marriage details How to get the descendancy for a person with a specified spouse and return additional person details and marriage details.