Read Place Descriptions Group

This example request illustrates how to read a place descriptions group. A place descriptions group is an arbitrary grouping of place descriptions or other groups. Partners can use this resource to get a group of place descriptions that are related, such as countries in North America.

JSON

Request

GET /platform/places/groups/12345
Accept: application/x-gedcomx-v1+json
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE

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
Cache-control: no-transform, must-revalidate, max-age=86400
Transfer-encoding: chunked{
  "description" : "#12345",
  "sourceDescriptions" : [ {
    "id" : "12345",
    "links" : {
      "place-group" : {
        "href" : "https://api.familysearch.org/platform/places/groups/12345?flag=fsh"
      }
    },
    "titles" : [ {
      "value" : "Regions of the World"
    } ]
  } ],
  "places" : [ {
    "id" : "abc",
    "type" : "http://familysearch.org/v1/PlaceGroup",
    "links" : {
      "place-group" : {
        "href" : "https://api.familysearch.org/platform/places/groups/abc?flag=fsh"
      }
    },
    "names" : [ {
      "lang" : "en",
      "value" : "North America"
    }, {
      "lang" : "zh",
      "value" : "北美"
    } ]
  }, {
    "id" : "212",
    "links" : {
      "description" : {
        "href" : "https://api.familysearch.org/platform/places/description/212?flag=fsh"
      }
    },
    "names" : [ {
      "lang" : "en",
      "value" : "Australia"
    }, {
      "lang" : "zh",
      "value" : "澳大利亚"
    } ]
  }, {
    "id" : "cde",
    "type" : "http://familysearch.org/v1/PlaceGroup",
    "links" : {
      "place-group" : {
        "href" : "https://api.familysearch.org/platform/places/groups/cde?flag=fsh"
      }
    },
    "names" : [ {
      "lang" : "en",
      "value" : "South America"
    }, {
      "lang" : "zh",
      "value" : "南美洲"
    } ]
  }, {
    "id" : "dfg",
    "type" : "http://familysearch.org/v1/PlaceGroup",
    "links" : {
      "place-group" : {
        "href" : "https://api.familysearch.org/platform/places/groups/dfg?flag=fsh"
      }
    },
    "names" : [ {
      "lang" : "en",
      "value" : "Asia"
    }, {
      "lang" : "zh",
      "value" : "亚洲"
    } ]
  }, {
    "id" : "fgh",
    "type" : "http://familysearch.org/v1/PlaceGroup",
    "links" : {
      "place-group" : {
        "href" : "https://api.familysearch.org/platform/places/groups/fgh?flag=fsh"
      }
    },
    "names" : [ {
      "lang" : "en",
      "value" : "Europe"
    }, {
      "lang" : "zh",
      "value" : "欧洲"
    } ]
  }, {
    "id" : "ghi",
    "type" : "http://familysearch.org/v1/PlaceGroup",
    "links" : {
      "place-group" : {
        "href" : "https://api.familysearch.org/platform/places/groups/ghi?flag=fsh"
      }
    },
    "names" : [ {
      "lang" : "en",
      "value" : "Africa"
    }, {
      "lang" : "zh-Kana",
      "value" : "アーカンソー州"
    } ]
  } ]
}

XML

Request

GET /platform/places/groups/12345
Accept: application/x-gedcomx-v1+xml
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE

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
Cache-control: no-transform, must-revalidate, max-age=86400
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" description="#12345">
    <sourceDescription id="12345">
        <link rel="place-group" href="https://api.familysearch.org/platform/places/groups/12345?flag=fsh"/>
        <title>Regions of the World</title>
    </sourceDescription>
    <place type="http://familysearch.org/v1/PlaceGroup" id="abc">
        <link rel="place-group" href="https://api.familysearch.org/platform/places/groups/abc?flag=fsh"/>
        <name xml:lang="en">North America</name>
        <name xml:lang="zh">北美</name>
    </place>
    <place id="212">
        <link rel="description" href="https://api.familysearch.org/platform/places/description/212?flag=fsh"/>
        <name xml:lang="en">Australia</name>
        <name xml:lang="zh">澳大利亚</name>
    </place>
    <place type="http://familysearch.org/v1/PlaceGroup" id="cde">
        <link rel="place-group" href="https://api.familysearch.org/platform/places/groups/cde?flag=fsh"/>
        <name xml:lang="en">South America</name>
        <name xml:lang="zh">南美洲</name>
    </place>
    <place type="http://familysearch.org/v1/PlaceGroup" id="dfg">
        <link rel="place-group" href="https://api.familysearch.org/platform/places/groups/dfg?flag=fsh"/>
        <name xml:lang="en">Asia</name>
        <name xml:lang="zh">亚洲</name>
    </place>
    <place type="http://familysearch.org/v1/PlaceGroup" id="fgh">
        <link rel="place-group" href="https://api.familysearch.org/platform/places/groups/fgh?flag=fsh"/>
        <name xml:lang="en">Europe</name>
        <name xml:lang="zh">欧洲</name>
    </place>
    <place type="http://familysearch.org/v1/PlaceGroup" id="ghi">
        <link rel="place-group" href="https://api.familysearch.org/platform/places/groups/ghi?flag=fsh"/>
        <name xml:lang="en">Africa</name>
        <name xml:lang="zh-Kana">アーカンソー州</name>
    </place>
</gedcomx>