Read Person Matches using Gedcomx
This example request illustrates how to request matches for an example person. The example person is described using the a Gedcomx document passed in the body.
JSON
Request
POST /platform/tree/matches?count=10
Content-Type: application/x-gedcomx-v1+json
Accept: application/x-gedcomx-atom+json
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE{
"description" : "#sd1",
"persons" : [ {
"id" : "primaryPerson",
"gender" : {
"type" : "http://gedcomx.org/Male"
},
"names" : [ {
"type" : "http://gedcomx.org/BirthName",
"nameForms" : [ {
"fullText" : "Israel Heaton"
} ]
} ],
"facts" : [ {
"type" : "http://gedcomx.org/Birth",
"date" : {
"original" : "30 January 1880"
},
"place" : {
"original" : "Orderville, UT"
}
}, {
"type" : "http://gedcomx.org/Death",
"date" : {
"original" : "29 August 1936"
},
"place" : {
"original" : "Kanab, Kane, UT"
}
} ]
}, {
"id" : "father1",
"gender" : {
"type" : "http://gedcomx.org/Male"
},
"names" : [ {
"nameForms" : [ {
"fullText" : "Jonathan Heaton"
} ]
} ]
}, {
"id" : "mother1",
"gender" : {
"type" : "http://gedcomx.org/Female"
},
"names" : [ {
"nameForms" : [ {
"fullText" : "Clarissa Hoyt"
} ]
} ]
}, {
"id" : "spouse1",
"gender" : {
"type" : "http://gedcomx.org/Female"
},
"names" : [ {
"nameForms" : [ {
"fullText" : "Charlotte Cox"
} ]
} ]
}, {
"id" : "child1",
"gender" : {
"type" : "http://gedcomx.org/Male"
},
"names" : [ {
"nameForms" : [ {
"fullText" : "Alma Heaton"
} ]
} ]
} ],
"relationships" : [ {
"type" : "http://gedcomx.org/ParentChild",
"person1" : {
"resource" : "#father1"
},
"person2" : {
"resource" : "#primaryPerson"
}
}, {
"type" : "http://gedcomx.org/ParentChild",
"person1" : {
"resource" : "#mother1"
},
"person2" : {
"resource" : "#primaryPerson"
}
}, {
"type" : "http://gedcomx.org/Couple",
"person1" : {
"resource" : "#primaryPerson"
},
"person2" : {
"resource" : "#spouse1"
}
}, {
"type" : "http://gedcomx.org/ParentChild",
"person1" : {
"resource" : "#primaryPerson"
},
"person2" : {
"resource" : "#child1"
}
} ],
"sourceDescriptions" : [ {
"id" : "sd1",
"about" : "#primaryPerson",
"identifiers" : {
"http://gedcomx.org/Persistent" : [ "#sd1" ]
}
} ]
}
Response
HTTP/1.1 200 OK
Content-type: application/x-gedcomx-atom+json
X-processing-time: 3
Vary: Accept,Accept-Language,Accept-Encoding,Expect
Date: Sun, 03 Apr 1836 10:00:00 GMT-5
Cache-control: no-cache, no-store, no-transform, must-revalidate, max-age=0
Transfer-encoding: chunked{
"id" : "uuid:random_uuid",
"results" : 2,
"index" : 1,
"subtitle" : "Results for person matches with gedcomx.",
"title" : "Person Match Results",
"updated" : 1543677067759,
"links" : {
"self" : {
"href" : "https://api.familysearch.org/platform/tree/matches?flag=fsh&count=10"
}
},
"entries" : [ {
"content" : {
"gedcomx" : {
"description" : "#sd1",
"persons" : [ {
"id" : "primaryPerson",
"gender" : {
"type" : "http://gedcomx.org/Male"
},
"links" : {
"person" : {
"href" : "https://api.familysearch.org/platform/tree/persons/primaryPerson?flag=fsh"
},
"portrait" : {
"href" : "https://api.familysearch.org/platform/tree/persons/primaryPerson/portrait?flag=fsh"
}
},
"names" : [ {
"type" : "http://gedcomx.org/BirthName",
"nameForms" : [ {
"fullText" : "Israel Heaton"
} ]
} ],
"facts" : [ {
"type" : "http://gedcomx.org/Birth",
"date" : {
"original" : "30 January 1880"
},
"place" : {
"original" : "Orderville, UT"
}
}, {
"type" : "http://gedcomx.org/Death",
"date" : {
"original" : "29 August 1936"
},
"place" : {
"original" : "Kanab, Kane, UT"
}
} ]
}, {
"id" : "father1",
"gender" : {
"type" : "http://gedcomx.org/Male"
},
"links" : {
"person" : {
"href" : "https://api.familysearch.org/platform/tree/persons/father1?flag=fsh"
},
"portrait" : {
"href" : "https://api.familysearch.org/platform/tree/persons/father1/portrait?flag=fsh"
}
},
"names" : [ {
"nameForms" : [ {
"fullText" : "Jonathan Heaton"
} ]
} ]
}, {
"id" : "mother1",
"gender" : {
"type" : "http://gedcomx.org/Female"
},
"links" : {
"person" : {
"href" : "https://api.familysearch.org/platform/tree/persons/mother1?flag=fsh"
},
"portrait" : {
"href" : "https://api.familysearch.org/platform/tree/persons/mother1/portrait?flag=fsh"
}
},
"names" : [ {
"nameForms" : [ {
"fullText" : "Clarissa Hoyt"
} ]
} ]
}, {
"id" : "spouse1",
"gender" : {
"type" : "http://gedcomx.org/Female"
},
"links" : {
"person" : {
"href" : "https://api.familysearch.org/platform/tree/persons/spouse1?flag=fsh"
},
"portrait" : {
"href" : "https://api.familysearch.org/platform/tree/persons/spouse1/portrait?flag=fsh"
}
},
"names" : [ {
"nameForms" : [ {
"fullText" : "Charlotte Cox"
} ]
} ]
}, {
"id" : "child1",
"gender" : {
"type" : "http://gedcomx.org/Male"
},
"links" : {
"person" : {
"href" : "https://api.familysearch.org/platform/tree/persons/child1?flag=fsh"
},
"portrait" : {
"href" : "https://api.familysearch.org/platform/tree/persons/child1/portrait?flag=fsh"
}
},
"names" : [ {
"nameForms" : [ {
"fullText" : "Alma Heaton"
} ]
} ]
} ],
"relationships" : [ {
"type" : "http://gedcomx.org/ParentChild",
"person1" : {
"resource" : "#father1"
},
"person2" : {
"resource" : "#primaryPerson"
}
}, {
"type" : "http://gedcomx.org/ParentChild",
"person1" : {
"resource" : "#mother1"
},
"person2" : {
"resource" : "#primaryPerson"
}
}, {
"type" : "http://gedcomx.org/Couple",
"person1" : {
"resource" : "#primaryPerson"
},
"person2" : {
"resource" : "#spouse1"
}
}, {
"type" : "http://gedcomx.org/ParentChild",
"person1" : {
"resource" : "#primaryPerson"
},
"person2" : {
"resource" : "#child1"
}
} ],
"sourceDescriptions" : [ {
"id" : "sd1",
"about" : "#primaryPerson",
"identifiers" : {
"http://gedcomx.org/Persistent" : [ "#sd1" ]
}
} ]
}
},
"id" : "MMM3-KG7",
"score" : 0.95,
"title" : "Person primaryPerson",
"updated" : 1543677067759,
"links" : {
"person" : {
"href" : "https://api.familysearch.org/platform/tree/persons/MMM3-KG7?flag=fsh"
}
}
}, {
"content" : {
"gedcomx" : {
"description" : "sd2",
"persons" : [ {
"id" : "MMM9-VMZ",
"links" : {
"person" : {
"href" : "https://api.familysearch.org/platform/tree/persons/MMM9-VMZ?flag=fsh"
},
"portrait" : {
"href" : "https://api.familysearch.org/platform/tree/persons/MMM9-VMZ/portrait?flag=fsh"
}
},
"identifiers" : {
"http://gedcomx.org/Persistent" : [ "https://familysearch.org/ark:/61903/4:1:MMM9-VMZ" ]
},
"names" : [ {
"type" : "http://gedcomx.org/BirthName",
"nameForms" : [ {
"fullText" : "Israel Hoyt Heaton"
} ]
} ],
"display" : {
"name" : "type=BirthName,nameForms[0]=Israel Hoyt Heaton,pref=null"
}
} ]
}
},
"id" : "MMM9-VMZ",
"score" : 0.85,
"title" : "Person MMM9-VMZ (type=BirthName,nameForms[0]=Israel Hoyt Heaton,pref=null)",
"updated" : 1543677067759,
"links" : {
"person" : {
"href" : "https://api.familysearch.org/platform/tree/persons/MMM9-VMZ?flag=fsh"
}
}
} ],
"searchInfo" : [ {
"totalHits" : 2,
"closeHits" : 1
} ]
}
XML
Request
POST /platform/tree/matches?count=10
Content-Type: application/x-gedcomx-v1+xml
Accept: application/atom+xml
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<gedcomx xmlns:fs="http://familysearch.org/v1/" xmlns="http://gedcomx.org/v1/" xmlns:atom="http://www.w3.org/2005/Atom" description="#sd1">
<person id="primaryPerson">
<gender type="http://gedcomx.org/Male"/>
<name type="http://gedcomx.org/BirthName">
<nameForm>
<fullText>Israel Heaton</fullText>
</nameForm>
</name>
<fact type="http://gedcomx.org/Birth">
<date>
<original>30 January 1880</original>
</date>
<place>
<original>Orderville, UT</original>
</place>
</fact>
<fact type="http://gedcomx.org/Death">
<date>
<original>29 August 1936</original>
</date>
<place>
<original>Kanab, Kane, UT</original>
</place>
</fact>
</person>
<person id="father1">
<gender type="http://gedcomx.org/Male"/>
<name>
<nameForm>
<fullText>Jonathan Heaton</fullText>
</nameForm>
</name>
</person>
<person id="mother1">
<gender type="http://gedcomx.org/Female"/>
<name>
<nameForm>
<fullText>Clarissa Hoyt</fullText>
</nameForm>
</name>
</person>
<person id="spouse1">
<gender type="http://gedcomx.org/Female"/>
<name>
<nameForm>
<fullText>Charlotte Cox</fullText>
</nameForm>
</name>
</person>
<person id="child1">
<gender type="http://gedcomx.org/Male"/>
<name>
<nameForm>
<fullText>Alma Heaton</fullText>
</nameForm>
</name>
</person>
<relationship type="http://gedcomx.org/ParentChild">
<person1 resource="#father1"/>
<person2 resource="#primaryPerson"/>
</relationship>
<relationship type="http://gedcomx.org/ParentChild">
<person1 resource="#mother1"/>
<person2 resource="#primaryPerson"/>
</relationship>
<relationship type="http://gedcomx.org/Couple">
<person1 resource="#primaryPerson"/>
<person2 resource="#spouse1"/>
</relationship>
<relationship type="http://gedcomx.org/ParentChild">
<person1 resource="#primaryPerson"/>
<person2 resource="#child1"/>
</relationship>
<sourceDescription about="#primaryPerson" id="sd1">
<identifier type="http://gedcomx.org/Persistent">#sd1</identifier>
</sourceDescription>
</gedcomx>
Response
HTTP/1.1 200 OK
Content-type: application/atom+xml
X-processing-time: 3
Vary: Accept,Accept-Language,Accept-Encoding,Expect
Date: Sun, 03 Apr 1836 10:00:00 GMT-5
Cache-control: no-cache, no-store, no-transform, must-revalidate, max-age=0
Transfer-encoding: chunked<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<feed xmlns:fs="http://familysearch.org/v1/" xmlns:gx="http://gedcomx.org/v1/" xmlns="http://www.w3.org/2005/Atom">
<fs:searchInfo>
<fs:closeHits>1</fs:closeHits>
<fs:totalHits>2</fs:totalHits>
</fs:searchInfo>
<id>uuid:random_uuid</id>
<gx:results>2</gx:results>
<gx:index>1</gx:index>
<link rel="self" href="https://api.familysearch.org/platform/tree/matches?flag=fsh&count=10"/>
<subtitle>Results for person matches with gedcomx.</subtitle>
<title>Person Match Results</title>
<updated>2018-12-01T08:11:07.759-07:00</updated>
<entry>
<content type="application/x-gedcomx-v1+xml">
<gx:gedcomx description="#sd1">
<gx:person id="primaryPerson">
<gx:link rel="person" href="https://api.familysearch.org/platform/tree/persons/primaryPerson?flag=fsh"/>
<gx:link rel="portrait" href="https://api.familysearch.org/platform/tree/persons/primaryPerson/portrait?flag=fsh"/>
<gx:gender type="http://gedcomx.org/Male"/>
<gx:name type="http://gedcomx.org/BirthName">
<gx:nameForm>
<gx:fullText>Israel Heaton</gx:fullText>
</gx:nameForm>
</gx:name>
<gx:fact type="http://gedcomx.org/Birth">
<gx:date>
<gx:original>30 January 1880</gx:original>
</gx:date>
<gx:place>
<gx:original>Orderville, UT</gx:original>
</gx:place>
</gx:fact>
<gx:fact type="http://gedcomx.org/Death">
<gx:date>
<gx:original>29 August 1936</gx:original>
</gx:date>
<gx:place>
<gx:original>Kanab, Kane, UT</gx:original>
</gx:place>
</gx:fact>
</gx:person>
<gx:person id="father1">
<gx:link rel="person" href="https://api.familysearch.org/platform/tree/persons/father1?flag=fsh"/>
<gx:link rel="portrait" href="https://api.familysearch.org/platform/tree/persons/father1/portrait?flag=fsh"/>
<gx:gender type="http://gedcomx.org/Male"/>
<gx:name>
<gx:nameForm>
<gx:fullText>Jonathan Heaton</gx:fullText>
</gx:nameForm>
</gx:name>
</gx:person>
<gx:person id="mother1">
<gx:link rel="person" href="https://api.familysearch.org/platform/tree/persons/mother1?flag=fsh"/>
<gx:link rel="portrait" href="https://api.familysearch.org/platform/tree/persons/mother1/portrait?flag=fsh"/>
<gx:gender type="http://gedcomx.org/Female"/>
<gx:name>
<gx:nameForm>
<gx:fullText>Clarissa Hoyt</gx:fullText>
</gx:nameForm>
</gx:name>
</gx:person>
<gx:person id="spouse1">
<gx:link rel="person" href="https://api.familysearch.org/platform/tree/persons/spouse1?flag=fsh"/>
<gx:link rel="portrait" href="https://api.familysearch.org/platform/tree/persons/spouse1/portrait?flag=fsh"/>
<gx:gender type="http://gedcomx.org/Female"/>
<gx:name>
<gx:nameForm>
<gx:fullText>Charlotte Cox</gx:fullText>
</gx:nameForm>
</gx:name>
</gx:person>
<gx:person id="child1">
<gx:link rel="person" href="https://api.familysearch.org/platform/tree/persons/child1?flag=fsh"/>
<gx:link rel="portrait" href="https://api.familysearch.org/platform/tree/persons/child1/portrait?flag=fsh"/>
<gx:gender type="http://gedcomx.org/Male"/>
<gx:name>
<gx:nameForm>
<gx:fullText>Alma Heaton</gx:fullText>
</gx:nameForm>
</gx:name>
</gx:person>
<gx:relationship type="http://gedcomx.org/ParentChild">
<gx:person1 resource="#father1"/>
<gx:person2 resource="#primaryPerson"/>
</gx:relationship>
<gx:relationship type="http://gedcomx.org/ParentChild">
<gx:person1 resource="#mother1"/>
<gx:person2 resource="#primaryPerson"/>
</gx:relationship>
<gx:relationship type="http://gedcomx.org/Couple">
<gx:person1 resource="#primaryPerson"/>
<gx:person2 resource="#spouse1"/>
</gx:relationship>
<gx:relationship type="http://gedcomx.org/ParentChild">
<gx:person1 resource="#primaryPerson"/>
<gx:person2 resource="#child1"/>
</gx:relationship>
<gx:sourceDescription about="#primaryPerson" id="sd1">
<gx:identifier type="http://gedcomx.org/Persistent">#sd1</gx:identifier>
</gx:sourceDescription>
</gx:gedcomx>
</content>
<id>MMM3-KG7</id>
<link rel="person" href="https://api.familysearch.org/platform/tree/persons/MMM3-KG7?flag=fsh"/>
<gx:score>0.95</gx:score>
<title>Person primaryPerson</title>
<updated>2018-12-01T08:11:07.759-07:00</updated>
</entry>
<entry>
<content type="application/x-gedcomx-v1+xml">
<gx:gedcomx description="sd2">
<gx:person id="MMM9-VMZ">
<gx:link rel="person" href="https://api.familysearch.org/platform/tree/persons/MMM9-VMZ?flag=fsh"/>
<gx:link rel="portrait" href="https://api.familysearch.org/platform/tree/persons/MMM9-VMZ/portrait?flag=fsh"/>
<gx:identifier type="http://gedcomx.org/Persistent">https://familysearch.org/ark:/61903/4:1:MMM9-VMZ</gx:identifier>
<gx:name type="http://gedcomx.org/BirthName">
<gx:nameForm>
<gx:fullText>Israel Hoyt Heaton</gx:fullText>
</gx:nameForm>
</gx:name>
<gx:display>
<gx:name>type=BirthName,nameForms[0]=Israel Hoyt Heaton,pref=null</gx:name>
</gx:display>
</gx:person>
</gx:gedcomx>
</content>
<id>MMM9-VMZ</id>
<link rel="person" href="https://api.familysearch.org/platform/tree/persons/MMM9-VMZ?flag=fsh"/>
<gx:score>0.85</gx:score>
<title>Person MMM9-VMZ (type=BirthName,nameForms[0]=Israel Hoyt Heaton,pref=null)</title>
<updated>2018-12-01T08:11:07.759-07:00</updated>
</entry>
</feed>
Updated 5 days ago