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
descendancy number, but the
descendancy number will have a
-S appended to indicate the role of spouse.
In the case where multiple spouses are provided, the
-S may be suffixed by a number indicating the spouse number. This applies to each subsequent generation. For example:
|1||The root person.|
|1-S||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-S||The primary spouse of the fifth child (via the primary spouse) of the second child (via the primary spouse) of the root person.|
personparameter is the ID for the person at the root of the descendancy. The
personparameter is required. The
descendancy numberof the person identified by the person parameter is 1.
- The presence of the
spouseparameter indicates that the descendancy is narrowed to a specific spouse. When the
spouseparameter is supplied, the
descendancy numberof both the person and the spouse will be 1 (the spouse will have a
-Sappended to the number).
- If the value of the
spouseparameter is empty, the application will return the descendancy of a person narrowed to the "unknown" spouse.
- Otherwise the value of the
spouseparameter is interpreted as the ID of the spouse selected for the descendancy.
- If the value of the
If you make a
GET request, specify the desired data format using the
POST something, specify the data format using the
|Authorization||header||The authorization carrying the OAuth 2.0 access token. See OAuth 2.0 Bearer Tokens.|
|access_token||query||The ID of the OAuth 2 access token used for identification and authorization of the user (and agent) making the request.|
|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.|
|personDetails||query||When the query parameter is supplied then additional person details will be returned for each person in the descendancy.|
|spouse||query||If provided, the descendancy will be narrowed to a specific spouse. If not provided, the system will select a spouse. A value of "UNKNOWN" indicates the system will select the "unknown" spouse.|
GET - Query for a person and the descendants of the person for a number of generations.
|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.|