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 supports 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. The '#' indicates the spouse number.

descendancy number description
1 The root person.
1-S1 The (primary) spouse of the root person.
1-S2 The second spouse of the root person.
1.3 The third child (via the primary spouse) of the root person.
1-S2.2 The second child (via the second spouse)of the root person.
1.2-S3.4 The fourth child (via the 3rd spouse) of the second child (via the primary spouse) of the root person.
1.2.5-S1 The primary spouse of the fifth child (via the primary spouse) of the second child (via the primary spouse) of the root person.

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.

Operations

GET - Query for a person and the descendants of the person for a number of generations.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
generations query The number of generations being queried. Default=1. Min=1. Max=4.
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. Required.
personDetails query When the query parameter is supplied then additional person details will be returned for each person in the descendancy.
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.

Change Language

Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.