Attention: This site does not support the current version of your web browser. To get the best possible experience using our website we recommend that you upgrade to a newer version or install another browser

Skip main navigation

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.


Data Format: application/x-fs-v1+xml
Root Element: FamilySearch
Version: 1.0
Extends: GEDCOM X (XML)

Data Types

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>
  <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>
    <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/>
    <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/>
    <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>
Change Language
Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.