XML

Gedcomx (JSON)

The GEDCOM X data formats define the serialization formats of the GEDCOM X conceptual model. The canonical documentation is provided by the formal specification documents:

This documentation is provided as a non-normative reference guide.

Namespace:http://gedcomx.org/v1/
URI:http://gedcomx.org/v1/Gedcomx
Extends:HypermediaEnabledData

Properties

Name Type Description
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

{
  "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" : "..."
}