v1

latestOpenAPI 3.0.1Apache 2.02026-07-2420454370.2 KB
Places

Read Place Description With Related

Read a place description with its related place descriptions. This resource is a representation of the place in a given time period, within a specific jurisdiction, with a specific official name. Place Descriptions have a unique, numeric identifier. The identifiers for the Place Description resource are in a different namespace than the identifier for the Place resource. For example, Place identifier 123 is not the same as Place Description 123. These unique identifiers can be used to associate places with their own data, providing a powerful way to link data together.

This endpoint returns all of the place descriptions related to the place description requested. Related place descriptions have a type of DELETED, SAME_NAME, SAME_PLACE or ASSOCIATED. ASSOCIATED types can have a sub-type whose values are free-form.

get/places/description/{pdid}/related

Path parameters

pdidstring required

The ID of the place description. To find place description IDs, see <a href="/reference/readplaces" target="_blank">Read Places</a>.

Query parameters

deletedSincestring

Only return DELETED related place descriptions that were deleted on or after this date.

Headers

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

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

Response

The read was successful. See <a href="https://developers.familysearch.org/main/docs/json-schema#placedescription" target="_blank">PlaceDescription Schema (JSON)</a>