Read Place Descriptions

This example request illustrates how to get a list of place descriptions. A place description has a unique numeric identifier and is a representation of the logical place in a given time period, within a specific jurisdiction, with a specific official name.

JSON

Request

GET /platform/places/description?pdids=7344697,3988097
Accept: application/x-fs-v1+json
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE

Response

HTTP/1.1 200 OK
Content-type: application/x-fs-v1+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{
  "places" : [ {
    "id" : "7344697",
    "lang" : "fr",
    "temporalDescription" : {
      "formal" : "+1968/"
    },
    "latitude" : 48.86024,
    "longitude" : 2.341109,
    "jurisdiction" : {
      "resource" : "#442102"
    },
    "identifiers" : {
      "http://gedcomx.org/Persistent" : [ "http://api.familysearch.org/platform/places/5061509" ]
    },
    "names" : [ {
      "value" : "Paris"
    } ],
    "display" : {
      "name" : "Paris",
      "fullName" : "Paris, Ville-de-Paris, District of the Paris Region, France",
      "type" : "Populated Place"
    }
  }, {
    "id" : "3988097",
    "lang" : "en",
    "latitude" : 42.22722,
    "longitude" : -111.40028,
    "jurisdiction" : {
      "resource" : "#393946"
    },
    "identifiers" : {
      "http://gedcomx.org/Persistent" : [ "http://api.familysearch.org/platform/places/344619" ]
    },
    "names" : [ {
      "value" : "Paris"
    } ],
    "display" : {
      "name" : "Paris",
      "fullName" : "Paris, Bear Lake, Idaho, United States",
      "type" : "City"
    }
  } ]
}

XML

Request

GET /platform/places/description?pdids=7344697,3988097
Accept: application/x-fs-v1+xml
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE

Response

HTTP/1.1 200 OK
Content-type: application/x-fs-v1+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"?>
<fs:familysearch xmlns:fs="http://familysearch.org/v1/" xmlns="http://gedcomx.org/v1/" xmlns:atom="http://www.w3.org/2005/Atom">
    <place xml:lang="fr" id="7344697">
        <identifier type="http://gedcomx.org/Persistent">http://api.familysearch.org/platform/places/5061509</identifier>
        <name>Paris</name>
        <temporalDescription>
            <formal>+1968/</formal>
        </temporalDescription>
        <latitude>48.86024</latitude>
        <longitude>2.341109</longitude>
        <jurisdiction resource="#442102"/>
        <display>
            <fullName>Paris, Ville-de-Paris, District of the Paris Region, France</fullName>
            <name>Paris</name>
            <type>Populated Place</type>
        </display>
    </place>
    <place xml:lang="en" id="3988097">
        <identifier type="http://gedcomx.org/Persistent">http://api.familysearch.org/platform/places/344619</identifier>
        <name>Paris</name>
        <latitude>42.22722</latitude>
        <longitude>-111.40028</longitude>
        <jurisdiction resource="#393946"/>
        <display>
            <fullName>Paris, Bear Lake, Idaho, United States</fullName>
            <name>Paris</name>
            <type>City</type>
        </display>
    </place>
</fs:familysearch>