Read Genealogies Persons By External Ids

This example request illustrates how to read a set of genealogies persons by external ids. Note that the persons are queried by POSTing a set of descriptions of the persons that contain theidentifiersfor each person.

JSON

Request

POST /platform/genealogies/trees/2:2:12345/persons/external-ids
Content-Type: application/x-gedcomx-v1+json
Accept: application/x-gedcomx-v1+json
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE{
  "sourceDescriptions" : [ {
    "identifiers" : {
      "http://customdomain.com/identifier" : [ "12345" ]
    }
  }, {
    "identifiers" : {
      "http://customdomain.com/identifier" : [ "23456" ]
    }
  } ]
}

Response

HTTP/1.1 200 OK
Content-type: application/x-gedcomx-v1+json
X-processing-time: 3
Vary: Accept,Accept-Language,Accept-Encoding,Expect
Date: Sun, 03 Apr 1836 10:00:00 GMT-5
Transfer-encoding: chunked{
  "persons" : [ {
    "id" : "MMM-MMM1",
    "links" : {
      "person" : {
        "href" : "https://api.familysearch.org/platform/genealogies/persons/MMM-MMM1?flag=fsh"
      }
    },
    "identifiers" : {
      "http://customdomain.com/identifier" : [ "12345" ]
    }
  }, {
    "id" : "MMM-MMM2",
    "links" : {
      "person" : {
        "href" : "https://api.familysearch.org/platform/genealogies/persons/MMM-MMM2?flag=fsh"
      }
    },
    "identifiers" : {
      "http://customdomain.com/identifier" : [ "23456" ]
    }
  } ]
}

XML

Request

POST /platform/genealogies/trees/2:2:12345/persons/external-ids
Content-Type: application/x-gedcomx-v1+xml
Accept: application/x-gedcomx-v1+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">
    <sourceDescription>
        <identifier type="http://customdomain.com/identifier">12345</identifier>
    </sourceDescription>
    <sourceDescription>
        <identifier type="http://customdomain.com/identifier">23456</identifier>
    </sourceDescription>
</gedcomx>

Response

HTTP/1.1 200 OK
Content-type: application/x-gedcomx-v1+xml
X-processing-time: 3
Vary: Accept,Accept-Language,Accept-Encoding,Expect
Date: Sun, 03 Apr 1836 10:00:00 GMT-5
Transfer-encoding: chunked<?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">
    <person id="MMM-MMM1">
        <link rel="person" href="https://api.familysearch.org/platform/genealogies/persons/MMM-MMM1?flag=fsh"/>
        <identifier type="http://customdomain.com/identifier">12345</identifier>
    </person>
    <person id="MMM-MMM2">
        <link rel="person" href="https://api.familysearch.org/platform/genealogies/persons/MMM-MMM2?flag=fsh"/>
        <identifier type="http://customdomain.com/identifier">23456</identifier>
    </person>
</gedcomx>