XML

FamilySearch (JSON)

The FamilySearch data types define serialization formats that are specific 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
childAndParentsRelationships array of ChildAndParentsRelationship The child-and-parents relationships for this data set.
discussions array of Discussion The discussions included in this data set.
users array of User The users included in this data set.
merges array of Merge The merges for this data set.
mergeAnalyses array of MergeAnalysis The merge analysis results for this data set.
features array of FeatureSet The set of features defined in the platform API.
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.
description string A reference to a description of this data set. FTU
profile string A reference to the profile that describes this data set.
attribution Attribution The attribution of this genealogical data.
persons array of Person The persons included in this genealogical data set.
relationships array of Relationship The relationships included in this genealogical data set.
sourceDescriptions array of SourceDescription The descriptions of sources included in this genealogical data set.
agents array of Agent The agents included in this genealogical data set.
events array of Event The events included in this genealogical data set.
places array of PlaceDescription The places included in this genealogical data set.
documents array of Document The documents included in this genealogical data set.
collections array of Collection The collections included in this genealogical data set. FTU
fields array of Field The extracted fields included in this genealogical data set. Fields that apply to a particular person, relationship or value should be included within that person or value, respectively. Remaining fields that did not have a place within the person or relationship structure can be included here. Also, fields that were extracted but not yet fit into a structure can also be included here. FTU
recordDescriptors array of RecordDescriptor The record descriptors included in this genealogical data set. FTU
Properties inherited from HypermediaEnabledData
links array 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

{
  "childAndParentsRelationships" : [ {
    "father" : {
    },
    "mother" : {
    },
    "child" : {
    },
    "fatherFacts" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "motherFacts" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "extracted" : false,
    "evidence" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "media" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "identifiers" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "confidence" : "...",
    "sortKey" : "...",
    "lang" : "...",
    "attribution" : {
    },
    "sources" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "analysis" : {
    },
    "notes" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "links" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "id" : "..."
  }, ... ],
  "discussions" : [ {
    "title" : "...",
    "details" : "...",
    "created" : "...",
    "contributor" : {
    },
    "modified" : "...",
    "numberOfComments" : ...,
    "comments" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "links" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "id" : "..."
  }, ... ],
  "users" : [ {
    "alternateEmail" : "...",
    "birthDate" : "...",
    "contactName" : "...",
    "country" : "...",
    "displayName" : "...",
    "email" : "...",
    "familyName" : "...",
    "fullName" : "...",
    "gender" : "...",
    "givenName" : "...",
    "helperAccessPin" : "...",
    "ldsMemberAccount" : false,
    "mailingAddress" : "...",
    "mobilePhoneNumber" : "...",
    "personId" : "...",
    "phoneNumber" : "...",
    "preferredLanguage" : "...",
    "treeUserId" : "...",
    "links" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "id" : "..."
  }, ... ],
  "merges" : [ {
    "resourcesToDelete" : [ {
    }, ... ],
    "resourcesToCopy" : [ {
    }, ... ]
  }, ... ],
  "mergeAnalyses" : [ {
    "survivorResources" : [ {
    }, ... ],
    "duplicateResources" : [ {
    }, ... ],
    "conflictingResources" : [ {
    }, ... ],
    "survivor" : {
    },
    "duplicate" : {
    }
  }, ... ],
  "features" : [ {
    "name" : "...",
    "description" : "...",
    "enabled" : false,
    "activationDate" : "..."
  }, ... ],
  "lang" : "...",
  "description" : "...",
  "profile" : "...",
  "attribution" : {
    "contributor" : {
    },
    "modified" : "...",
    "changeMessage" : "...",
    "id" : "..."
  },
  "persons" : [ {
    "principal" : false,
    "private" : false,
    "living" : false,
    "gender" : {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    },
    "names" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "facts" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "fields" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "display" : {
    },
    "extracted" : false,
    "evidence" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "media" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "identifiers" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "confidence" : "...",
    "sortKey" : "...",
    "lang" : "...",
    "attribution" : {
    },
    "sources" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "analysis" : {
    },
    "notes" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "links" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "id" : "..."
  }, ... ],
  "relationships" : [ {
    "type" : "...",
    "person1" : {
    },
    "person2" : {
    },
    "facts" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "fields" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "extracted" : false,
    "evidence" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "media" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "identifiers" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "confidence" : "...",
    "sortKey" : "...",
    "lang" : "...",
    "attribution" : {
    },
    "sources" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "analysis" : {
    },
    "notes" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "links" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "id" : "..."
  }, ... ],
  "sourceDescriptions" : [ {
    "about" : ...,
    "lang" : "...",
    "mediaType" : "...",
    "sortKey" : "...",
    "resourceType" : "...",
    "citations" : [ {
      "fields" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      },
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "mediator" : {
    },
    "sources" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "analysis" : {
    },
    "componentOf" : {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    },
    "titles" : [ {
    }, ... ],
    "titleLabel" : {
    },
    "notes" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "attribution" : {
    },
    "descriptions" : [ {
    }, ... ],
    "identifiers" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "created" : "...",
    "modified" : "...",
    "coverage" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "rights" : [ "...", ... ],
    "fields" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "repository" : {
    },
    "descriptor" : {
    },
    "replacedBy" : "...",
    "replaces" : [ "...", ... ],
    "statuses" : [ "...", ... ],
    "links" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "id" : "..."
  }, ... ],
  "agents" : [ {
    "accounts" : [ {
    }, ... ],
    "addresses" : [ {
    }, ... ],
    "emails" : [ {
    }, ... ],
    "homepage" : {
    },
    "identifiers" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "names" : [ {
    }, ... ],
    "openid" : {
    },
    "phones" : [ {
    }, ... ],
    "links" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "id" : "..."
  }, ... ],
  "events" : [ {
    "type" : "...",
    "date" : {
    },
    "place" : {
    },
    "roles" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "extracted" : false,
    "evidence" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "media" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "identifiers" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "confidence" : "...",
    "sortKey" : "...",
    "lang" : "...",
    "attribution" : {
    },
    "sources" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "analysis" : {
    },
    "notes" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "links" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "id" : "..."
  }, ... ],
  "places" : [ {
    "type" : "...",
    "names" : [ {
    }, ... ],
    "temporalDescription" : {
    },
    "latitude" : ...,
    "longitude" : ...,
    "spatialDescription" : {
    },
    "place" : {
    },
    "jurisdiction" : {
    },
    "display" : {
    },
    "extracted" : false,
    "evidence" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "media" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "identifiers" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "confidence" : "...",
    "sortKey" : "...",
    "lang" : "...",
    "attribution" : {
    },
    "sources" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "analysis" : {
    },
    "notes" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "links" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "id" : "..."
  }, ... ],
  "documents" : [ {
    "textType" : "...",
    "extracted" : false,
    "type" : "...",
    "text" : "...",
    "confidence" : "...",
    "sortKey" : "...",
    "lang" : "...",
    "attribution" : {
    },
    "sources" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "analysis" : {
    },
    "notes" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "links" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "id" : "..."
  }, ... ],
  "collections" : [ {
    "lang" : "...",
    "title" : "...",
    "size" : ...,
    "content" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "attribution" : {
    },
    "links" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "id" : "..."
  }, ... ],
  "fields" : [ {
    "type" : "...",
    "values" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "links" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "id" : "..."
  }, ... ],
  "recordDescriptors" : [ {
    "lang" : "...",
    "fields" : [ {
      "links" : {
        "type1" : [ {
        }, ... ],
        "type2" : [ {
        }, ... ],
        "..." : ...
      }
    }, ... ],
    "links" : {
      "type1" : [ {
      }, ... ],
      "type2" : [ {
      }, ... ],
      "..." : ...
    },
    "id" : "..."
  }, ... ],
  "links" : {
    "type1" : [ {
      "template" : "...",
      "allow" : "...",
      "count" : ...,
      "accept" : "...",
      "type" : "...",
      "hreflang" : "...",
      "title" : "...",
      "results" : ...,
      "rel" : "...",
      "offset" : ...,
      "href" : ...
    }, ... ],
    "type2" : [ {
      "template" : "...",
      "allow" : "...",
      "count" : ...,
      "accept" : "...",
      "type" : "...",
      "hreflang" : "...",
      "title" : "...",
      "results" : ...,
      "rel" : "...",
      "offset" : ...,
      "href" : ...
    }, ... ],
    "..." : ...
  },
  "id" : "..."
}