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.
personparameter is the ID for the person at the root of the pedigree. The
personparameter is required. The
ancestor numberof the person identified by the
personparameter will be 1, unless the
spouseparameter is provided.
- The presence of the
spouseparameter indicates that the pedigree of both the person and the person's spouse is requested. When the
spouseparameter is supplied, the
ascendancy numberof the person and the spouse is either 2 or 3, depending on the role of the person.
- If the value of the
spouseparameter is empty, the application may select a spouse for the person.
- Otherwise, the value of the
spouseparameter is interpreted as the ID of the spouse selected for the pedigree.
- 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.|
|descendants||query||When the query parameter is supplied then additional details will be returned for each descendant in the ancestry.|
|generations||query||The number of generations being queried. The max generations is 8.|
|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.|
|personDetails||query||When the query parameter is supplied then additional person details will be returned for each person in the ancestry.|
|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.|
GET - Query for a person and the ancestors of a person for a number of generations.
|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.|