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: fsapi-v1

  • Namespace: http://api.familysearch.org/v1
  • XML Schema File: fsapi-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 types are members of this namespace:


Type errorLevel

Possible Values

value description
Info
Warn
Error

Type FamilySearchElement

Base class for v1 root elements.

Attributes

name type description
statusCode int The response code.
deprecated boolean Deprecated flag.
statusMessage string The status message.
version string The version.

Child Elements

name (type) min/max
occurs
description
errors/error (FamilySearchError) 0/unbounded The errors.
properties/property (FamilySearchProperty) 0/unbounded The properties.

Type FamilySearchError

Default error implementation.

Attributes

name type description
level errorLevel (no documentation provided)
subcode int (no documentation provided)
code int (no documentation provided)

Child Elements

name (type) min/max
occurs
description
message (string) 0/1 (no documentation provided)
details (string) 0/1 (no documentation provided)

Type FamilySearchProperty

A basic property.

Attributes

name type description
name string (no documentation provided)

Value

  • Type:

(no documentation provided)