v1

latestOpenAPI 3.0.1Apache 2.02026-07-2420454370.2 KB
Persons

Read Person Merge

Read the current state of the potential merge by performing a merge analysis. The filter request parameter may be specified indicating which categories of information need to be analyzed. If no filter is specified then all categories will be used. The valid filter categories are listed below.

FilterDescription
CoupleRelationshipsAnalyze couple relationships
NonVitalConclusionsAnalyze non-vital conclusions
ParentChildRelationshipsAsChildAnalyze parent-child relationships as child
ParentChildRelationshipsAsParentAnalyze parent child relationships as parent
SourceReferencesAnalyze source references
VitalConclusionsAnalyze vital conclusions

The following results will be returned in the merge analysis.

CategoryDescription
survivorResourcesA list of resources that are unique to the survivor person or have same value in both survivor and duplicate persons
duplicateResourcesA list of resources on the duplicate person that do not exist on the survivor person
conflictingResourcesA list of conflicts where the resource exists in the survivor and the duplicate persons and have different values
survivorA person resource retained in the merge process
duplicateThe person resource deleted in the merge process
get/tree/persons/{pid}/merges/{dpid}

Path parameters

pidstring required

The id of the survivor. Can be a person from the main FamilySearch tree or from a user tree. To find an example person ID, see <a href="/reference/searchtreepersons" target="_blank">Search Tree Persons</a>.

dpidstring required

The id of the duplicate. Can be a person from the main FamilySearch tree or from a user tree. To find an example person ID, see <a href="/reference/searchtreepersons" target="_blank">Search Tree Persons</a>.

Query parameters

filterstring

The filter to apply to the merge analysis. One of "CoupleRelationships", "NonVitalConclusions", "ParentChildRelationshipsAsChild", "ParentChildRelationshipsAsParent", "SourceReferences", "VitalConclusions".

Headers

Accept'application/x-fs-v1+json' | 'application/json' | 'application/x-fs-v1+xml' | 'application/xml' required

Specifies the media type(s) that the client is willing to accept in the response.

Response

The merge analysis. See <a href="https://developers.familysearch.org/main/docs/json-schema#mergeanalysis" target="_blank">MergeAnalysis Schema (JSON)</a>