• Documentation >
• Data Formats >
• FamilySearch

FamilySearch (XML)

The FamilySearch data types define serialization formats that are specific to the FamilySearch developer platform. These data formats are extensions of the GEDCOM X media types and provide concepts and data types that are specific to FamilySearch and therefore haven't been adopted into a formal, more general specification.

Namespace:	http://familysearch.org/v1/
URI:	http://familysearch.org/v1/FamilySearch
Extends:	Gedcomx

Properties

Name	Type	Description
childAndParentsRelationship	list of ChildAndParentsRelationship	The child-and-parents relationships for this data set.
discussion	list of Discussion	The discussions included in this data set.
group	list of Group	The groups included in this data set.
tree	list of Tree	The trees included in this data set.
user	list of User	The users included in this data set.
merge	list of Merge	The merges for this data set.
mergeAnalysis	list of MergeAnalysis	The merge analysis results for this data set.
feature	list of FeatureSet	The set of features defined in the platform API.
vocabConcepts	list of VocabConcept	The vocabulary concepts included in this data set.
Properties inherited from Gedcomx
lang	string	The language of this genealogical data set. See http://www.w3.org/International/articles/language-tags/. Note that some language-enabled elements MAY override the language.
attribution	Attribution	The attribution of this genealogical data.
person	list of Person	The persons included in this genealogical data set.
relationship	list of Relationship	The relationships included in this genealogical data set.
sourceDescription	list of SourceDescription	The descriptions of sources included in this genealogical data set.
agent	list of Agent	The agents included in this genealogical data set.
event	list of Event	The events included in this genealogical data set.
place	list of PlaceDescription	The places included in this genealogical data set.
document	list of Document	The documents included in this genealogical data set.
Properties inherited from HypermediaEnabledData
link	list of Link	The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.
Properties inherited from ExtensibleData
id	string	A local, context-specific id for the data.

Example

<familysearch xml:lang="..." xmlns="http://familysearch.org/v1/">
  <childAndParentsRelationship extracted="...">
    <parent1 resource="..." resourceId="..."/>
    <parent2 resource="..." resourceId="..."/>
    <child resource="..." resourceId="..."/>
    <parent1Fact type="...">
      <date xmlns="http://gedcomx.org/v1/"/>
      <place xmlns="http://gedcomx.org/v1/"/>
      <value xmlns="http://gedcomx.org/v1/">...</value>
      <qualifier xmlns="http://gedcomx.org/v1/"/>
    </parent1Fact>
    <parent2Fact type="...">
      <date xmlns="http://gedcomx.org/v1/"/>
      <place xmlns="http://gedcomx.org/v1/"/>
      <value xmlns="http://gedcomx.org/v1/">...</value>
      <qualifier xmlns="http://gedcomx.org/v1/"/>
    </parent2Fact>
    <evidence xmlns="http://gedcomx.org/v1/"/>
    <media xmlns="http://gedcomx.org/v1/"/>
    <identifier xmlns="http://gedcomx.org/v1/"/>
  </childAndParentsRelationship>
  <discussion>
    <title>...</title>
    <details>...</details>
    <created>...</created>
    <contributor resource="..." resourceId="..."/>
    <modified>...</modified>
    <numberOfComments>...</numberOfComments>
    <comment>
      <text>...</text>
      <created>...</created>
      <contributor/>
    </comment>
    <link xmlns="http://gedcomx.org/v1/"/>
  </discussion>
  <group>
    <codeOfConduct>...</codeOfConduct>
    <description>...</description>
    <id>...</id>
    <members>
      <cisId>...</cisId>
      <contactName>...</contactName>
      <groupId>...</groupId>
      <status>...</status>
    </members>
    <name>...</name>
    <treeIds>...</treeIds>
  </group>
  <tree>
    <collectionId>...</collectionId>
    <description>...</description>
    <groupAccess>...</groupAccess>
    <groupIds>...</groupIds>
    <hidden>...</hidden>
    <id>...</id>
    <name>...</name>
    <ownerAccess>...</ownerAccess>
    <private>...</private>
    <startingPersonId>...</startingPersonId>
  </tree>
  <user>
    <alternateEmail>...</alternateEmail>
    <birthDate>...</birthDate>
    <contactName>...</contactName>
    <country>...</country>
    <displayName>...</displayName>
    <email>...</email>
    <familyName>...</familyName>
    <fullName>...</fullName>
    <gender>...</gender>
    <givenName>...</givenName>
    <helperAccessPin>...</helperAccessPin>
    <mailingAddress>...</mailingAddress>
    <mobilePhoneNumber>...</mobilePhoneNumber>
    <personId>...</personId>
    <phoneNumber>...</phoneNumber>
    <preferredLanguage>...</preferredLanguage>
    <treeUserId>...</treeUserId>
    <link xmlns="http://gedcomx.org/v1/"/>
  </user>
  <merge>
    <resourceToDelete resource="..." resourceId="..."/>
    <resourceToCopy resource="..." resourceId="..."/>
  </merge>
  <mergeAnalysis>
    <survivorResource resource="..." resourceId="..."/>
    <duplicateResource resource="..." resourceId="..."/>
    <conflictingResource>
      <survivorResource/>
      <duplicateResource/>
    </conflictingResource>
    <survivor resource="..." resourceId="..."/>
    <duplicate resource="..." resourceId="..."/>
  </mergeAnalysis>
  <feature>
    <name>...</name>
    <description>...</description>
    <enabled>...</enabled>
    <activationDate>...</activationDate>
  </feature>
  <vocabConcepts>
    <attributes>
      <id>...</id>
      <name>...</name>
      <value>...</value>
    </attributes>
    <definitions xml:lang="...">...</definitions>
    <description>...</description>
    <gedcomxUri>...</gedcomxUri>
    <note>...</note>
    <vocabTerms>
      <sublistPosition>...</sublistPosition>
      <sublistUri>...</sublistUri>
      <typeUri>...</typeUri>
      <values/>
    </vocabTerms>
    <link xmlns="http://gedcomx.org/v1/"/>
  </vocabConcepts>
  <attribution xmlns="http://gedcomx.org/v1/">
    <contributor/>
    <modified>...</modified>
    <changeMessage>...</changeMessage>
    <changeMessageResource>...</changeMessageResource>
    <creator/>
    <created>...</created>
  </attribution>
  <person private="..." xmlns="http://gedcomx.org/v1/">
    <living>...</living>
    <gender/>
    <name/>
    <fact/>
    <display/>
  </person>
  <relationship type="..." xmlns="http://gedcomx.org/v1/">
    <person1/>
    <person2/>
    <fact/>
  </relationship>
  <sourceDescription about="..." xml:lang="..." mediaType="..." resourceType="..." version="..." xmlns="http://gedcomx.org/v1/">
    <citation/>
    <mediator/>
    <publisher/>
    <authors>...</authors>
    <source/>
    <analysis/>
    <componentOf/>
    <title/>
    <note/>
    <attribution/>
    <identifier/>
    <rights>...</rights>
    <replacedBy>...</replacedBy>
    <replaces>...</replaces>
    <status>...</status>
  </sourceDescription>
  <agent xmlns="http://gedcomx.org/v1/">
    <account/>
    <address/>
    <email/>
    <homepage/>
    <identifier/>
    <name/>
    <openid/>
    <person/>
    <phone/>
  </agent>
  <event type="..." xmlns="http://gedcomx.org/v1/">
    <date/>
    <place/>
    <role/>
  </event>
  <place type="..." xmlns="http://gedcomx.org/v1/">
    <name/>
    <temporalDescription/>
    <latitude>...</latitude>
    <longitude>...</longitude>
    <spatialDescription/>
    <place/>
    <jurisdiction/>
    <display/>
  </place>
  <document extracted="..." textType="..." type="..." xmlns="http://gedcomx.org/v1/">
    <text>...</text>
  </document>
  <link xmlns="http://gedcomx.org/v1/"/>
</familysearch>