Relationship Finder

Prototype: This resource is currently in a prototype development state. It may or may not be operational and the interface may change prior to release. Feedback is welcome.

Path

`/platform/tree/persons/{pid}/relationships/{opid}`
Production:	https://api.familysearch.org/platform/tree/persons/{pid}/relationships/{opid}
Beta:	https://apibeta.familysearch.org/platform/tree/persons/{pid}/relationships/{opid}
Integration (Integration):	https://api-integ.familysearch.org/platform/tree/persons/{pid}/relationships/{opid}

Description

The Relationship Finder resource is used to to find how two persons in the tree are related. For finding how the currently logged in user is related to a person in the tree, pass in "CURRENT" for the first person Id. The later option requires an authenticated session.

Operations

GET - Return a list of persons which show how {pid} is related to a {opid}.

To determine which of the persons returned is the common ancestor the <fs:displatProperties> element will contain a "role" field that contains "commonAncestor" as a value.

Produces - Specify a returned data format using the Accept header.

Parameters

Name	Type	Description
opid	path	The terminal id to check for relation. Value is required.
pid	path	The the start id to check for relation. Value is required.
personDetails	query	When the query parameter is set to true, the additional person details will be returned for each person. Default=false.

Status Codes

200 - Upon a successful read.
204 - Upon a successful query with no results.
400 - If the query to be processed was unable to be understood by the application.

Example Requests

We haven't created any example requests yet.