Welcome to the new FamilySearch

Home
Introduction
downloads

XML Data Elements
authorities (authorities-v1)

XML Data Types
authorities (authorities-v1)
culture (authorities-v1)
date (authorities-v1)
dates (authorities-v1)
errorLevel (fsapi-v1)
FamilySearchElement (fsapi-v1)
FamilySearchError (fsapi-v1)
FamilySearchProperty (fsapi-v1)
name (authorities-v1)
nameEncodings (authorities-v1)
nameField (authorities-v1)
nameFieldType (authorities-v1)
namePiece (authorities-v1)
namePieceType (authorities-v1)
names (authorities-v1)
nameVariants (authorities-v1)
place (authorities-v1)
placeChain (authorities-v1)
placeLocation (authorities-v1)
placePoint (authorities-v1)
placeReference (authorities-v1)
places (authorities-v1)

Data: authorities-v1

  • Namespace: http://api.familysearch.org/authorities/v1
  • XML Schema File: authorities-v1.xsd

The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.

The following elements are members of this namespace:

The following types are members of this namespace:


Element authorities

Example XML

<?xml version="1.0" encoding="UTF-8"?> <authorities xmlns="http://api.familysearch.org/authorities/v1" statusCode="..." deprecated="..." statusMessage="..." version="..."> <places count="..." version="..."> <place iso="..." requestedId="..." type="..." id="..." original="..." culture="..."> <official>...</official> <normalized> <form>...</form> <form>...</form> <!--...more "form" elements...--> </normalized> <location> <point> <latitude>...</latitude> <longitude>...</longitude> </point> </location> <parents> <place ref="...">...</place> <place ref="...">...</place> <!--...more "place" elements...--> </parents> <children> <place ref="...">...</place> <place ref="...">...</place> <!--...more "place" elements...--> </children> <chains> <chains> <ancestors> <ancestor ref="...">...</ancestor> <ancestor ref="...">...</ancestor> <!--...more "ancestor" elements...--> </ancestors> </chains> <chains> <!--...--> </chains> <!--...more "chains" elements...--> </chains> <variants> <variant>...</variant> <variant>...</variant> <!--...more "variant" elements...--> </variants> </place> <place iso="..." requestedId="..." type="..." id="..." original="..." culture="..."> <!--...--> </place> <!--...more "place" elements...--> </places> <names count="..." version="..."> <name original="..."> <pieces> <piece text="..." type="..."> <predelimiters>...</predelimiters> <value>...</value> <postdelimiters>...</postdelimiters> <encodings> <soundex>...</soundex> <phondex>...</phondex> <nysiis>...</nysiis> </encodings> <variants id="..." culture="..."> <variant>...</variant> <variant>...</variant> <!--...more "variant" elements...--> </variants> <variants id="..." culture="..."> <!--...--> </variants> <!--...more "variants" elements...--> </piece> <piece text="..." type="..."> <!--...--> </piece> <!--...more "piece" elements...--> </pieces> <fields> <field text="..." type="..." /> <field text="..." type="..."> <!--...--> </field> <!--...more "field" elements...--> </fields> </name> <name original="..."> <!--...--> </name> <!--...more "name" elements...--> </names> <dates count="..." version="..."> <date valid="..." requested="..." original="..." ambiguous="..."> <normalized>...</normalized> <numeric>...</numeric> <astro>...</astro> <earliest> <!--...--> </earliest> <latest> <!--...--> </latest> </date> <date valid="..." requested="..." original="..." ambiguous="..."> <!--...--> </date> <!--...more "date" elements...--> </dates> <cultures> <culture id="..." requestedId="...">...</culture> <culture id="..." requestedId="...">...</culture> <!--...more "culture" elements...--> </cultures> <fsapi-v1:errors xmlns:fsapi-v1="http://api.familysearch.org/v1"> <fsapi-v1:error level="..." subcode="..." code="..."> <fsapi-v1:message>...</fsapi-v1:message> <fsapi-v1:details>...</fsapi-v1:details> </fsapi-v1:error> <fsapi-v1:error level="..." subcode="..." code="..."> <!--...--> </fsapi-v1:error> <!--...more "error" elements...--> </fsapi-v1:errors> <fsapi-v1:properties xmlns:fsapi-v1="http://api.familysearch.org/v1"> <fsapi-v1:property name="...">...</fsapi-v1:property> <fsapi-v1:property name="...">...</fsapi-v1:property> <!--...more "property" elements...--> </fsapi-v1:properties> </authorities>

Example JSON

{ "places" : { "count" : ..., "version" : "...", "place" : [ { "iso" : "...", "requestedId" : "...", "type" : "...", "id" : "...", "original" : "...", "culture" : "...", "official" : "...", "normalized" : [ "...", ... ], "location" : { "point" : { "latitude" : ..., "longitude" : ... } }, "parents" : [ { "ref" : "...", "value" : "..." }, ... ], "children" : [ { "ref" : "...", "value" : "..." }, ... ], "chains" : [ { "ancestors" : [ { "ref" : "...", "value" : "..." }, ... ] }, ... ], "variants" : [ "...", ... ] }, ... ] }, "names" : { "count" : ..., "version" : "...", "name" : [ { "original" : "...", "pieces" : [ { "text" : "...", "type" : "Given", "predelimiters" : "...", "value" : "...", "postdelimiters" : "...", "encodings" : { "soundex" : "...", "phondex" : "...", "nysiis" : "..." }, "variants" : [ { "id" : ..., "culture" : ..., "variant" : [ "...", ... ] }, ... ] }, ... ], "fields" : [ { "text" : "...", "type" : "Given" }, ... ] }, ... ] }, "dates" : { "count" : ..., "version" : "...", "date" : [ { "valid" : false, "requested" : "...", "original" : "...", "ambiguous" : false, "normalized" : "...", "numeric" : "...", "astro" : "...", "earliest" : { "..." : ... }, "latest" : { "..." : ... } }, ... ] }, "cultures" : [ { "id" : "...", "requestedId" : "...", "value" : "..." }, ... ], "statusCode" : ..., "deprecated" : false, "statusMessage" : "...", "version" : "...", "errors" : [ { "level" : "Info", "subcode" : ..., "code" : ..., "message" : "...", "details" : "..." }, ... ], "properties" : [ { "name" : "...", "value" : "..." }, ... ] }

Type authorities

Child Elements

name (type) min/max
occurs
description
places (places) 0/1 The authority places.
names (names) 0/1 The authority names.
dates (dates) 0/1 The authority dates.
cultures/culture (culture) 0/unbounded The authority cultures.

Type culture

An authority culture.

Attributes

name type description
id string the authority culture id.
requestedId string the authority culture requested id.

Value

  • Type:

the authority culture name.


Type date

An authority date.

Attributes

name type description
valid boolean true if the date is valid.
requested string the date requested.
original string the date original.
ambiguous boolean true if the date is ambiguous.

Child Elements

name (type) min/max
occurs
description
normalized (string) 0/1 Get the date normalization.
numeric (string) 0/1 Get the date numeric.
astro (string) 0/1 Get the astro day.
earliest (date) 0/1 Get the earliest date.
latest (date) 0/1 Get the latest date.

Type dates

A list of authority dates.

Attributes

name type description
count int the number of authority date interpretations.
version string the date authority version.

Child Elements

name (type) min/max
occurs
description
date (date) 0/unbounded Get a list of authority date interpretations.

Type name

A name authority name.

Attributes

name type description
original string the name original.

Child Elements

name (type) min/max
occurs
description
pieces/piece (namePiece) 0/unbounded Get the name authority name pieces.
fields/field (nameField) 0/unbounded Get the name authority name fields.

Type nameEncodings

A name authority name piece group.

Child Elements

name (type) min/max
occurs
description
soundex (string) 0/1 Get the name piece soundex code.
phondex (string) 0/1 Get the name piece phondex code.
nysiis (string) 0/1 Get the name piece NYSIIS code.

Type nameField

A name authority name field.

Attributes

name type description
text string the name field text.
type nameFieldType the name field type.

Type nameFieldType

An enumeration of authority name field types.

Possible Values

value description
Given Given Name
Prefix Prefix Name
Suffix Suffix Name
Family Family Name

Type namePiece

A name authority name piece or segment.

Attributes

name type description
text string the name piece text.
type namePieceType the name piece type.

Child Elements

name (type) min/max
occurs
description
predelimiters (string) 0/1 Get the name piece predelimiters text.
value (string) 0/1 Get the name piece value.
postdelimiters (string) 0/1 Get the name piece postdelimiters text.
encodings (nameEncodings) 0/1 Get the name piece encodings.
variants (nameVariants) 0/unbounded Get the name piece variants.

Type namePieceType

An enumeration of authority name piece types.

Possible Values

value description
Given Given Name
Other Other Name
Prefix Prefix Name
Suffix Suffix Name
Family Family Name

Type names

A list of name authority names.

Attributes

name type description
count int the number of authority names.
version string the name authority version.

Child Elements

name (type) min/max
occurs
description
name (name) 0/unbounded Get a list of name authority names.

Type nameVariants

A authority name piece variants.

Attributes

name type description
id int the name piece variants id.
culture byte the name piece variants culture id.

Child Elements

name (type) min/max
occurs
description
variant (string) 0/unbounded Get the name piece variants.

Type place

A place authority place.

Attributes

name type description
iso string the ISO code.
requestedId string the requested id of the place.
type string the place type.
id string the id of the place.
original string the place original.
culture string the place culture id.

Child Elements

name (type) min/max
occurs
description
official (string) 0/1 Get the official name of the place.
normalized/form (string) 0/unbounded Get a collection of normalized standard names of the place.
location (placeLocation) 0/1 Get the location of the place.
parents/place (placeReference) 0/unbounded Get the parent places.
children/place (placeReference) 0/unbounded Get the child places.
chains/chains (placeChain) 0/unbounded Get the place chains.
variants/variant (string) 0/unbounded Get the variant names of the place.

Type placeChain

A place ancestor chain place location.

Child Elements

name (type) min/max
occurs
description
ancestors/ancestor (placeReference) 0/unbounded Get the ancestors.

Type placeLocation

A place authority place location.

Child Elements

name (type) min/max
occurs
description
point (placePoint) 0/1 Get the point of the place.

Type placePoint

A place authority place location.

Child Elements

name (type) min/max
occurs
description
latitude (double) 1/1 Get the latitude of the place.
longitude (double) 1/1 Get the longitude of the place.

Type placeReference

A place authority place reference.

Attributes

name type description
ref string the place reference(id).

Value

  • Type:

the standard place name.


Type places

A list of place authority places.

Attributes

name type description
count int the number of authority places.
version string the place authority version.

Child Elements

name (type) min/max
occurs
description
place (place) 0/unbounded Get a list of place authority places.