JSON Schema
Address
An Address.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| city | The city. | string |
| country | The country. | string |
| postalCode | The postal code. | string |
| stateOrProvince | The state or province. | string |
| street | The street. | string |
| street2 | Additional street information. | string |
| street3 | Additional street information. | string |
| street4 | Additional street information. | string |
| street5 | Additional street information. | string |
| street6 | Additional street information. | string |
| value | The value of the property, if it can be expressed as a string. | string |
| extensionElement | - | object |
Agent
An agent, e.g. person, organization, or group. In genealogical research, an agent often takes the role of a contributor.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| homepage | - | ResourceReference |
| openid | - | ResourceReference |
| person | - | ResourceReference |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| names | The list of names for the agent. | array of TextValue |
| identifiers | The list of identifiers for the agent. | array |
| accounts | The accounts that belong to this person or organization. | array of OnlineAccount |
| emails | The emails that belong to this person or organization. | array of ResourceReference |
| phones | The phones that belong to this person or organization. | array of ResourceReference |
| addresses | The addresses that belong to this person or organization. | array of Address |
ArtifactMetadata
FamilySearch-specific metadata about an artifact.
Type: object
| Name | Description | Type |
|---|---|---|
| filename | The original filename of the memories item. | string |
| width | The width of the artifact (presumably an image). Format: int32 | integer |
| height | The height of the artifact (presumably an image). Format: int32 | integer |
| size | The size of the artifact. Format: int64 | integer |
| screeningState | The screening state of the artifact. | string |
| displayState | The display state of the artifact. | string |
| editable | Whether or not the artifact is editable by the current user. | boolean |
| qualifiers | The qualifiers associated with this artifact. | array of Qualifier |
Attribution
Attribution for genealogical information. Attribution is used to model who is contributing/modifying information, when they contributed it, and why they are making the contribution/modification.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| contributor | - | ResourceReference |
| creator | - | ResourceReference |
| modified | The modified timestamp for the attributed data. Format: date-time | string |
| created | The created timestamp for the attributed data. Format: date-time | string |
| changeMessage | The "change message" for the attributed data provided by the contributor. | string |
| changeMessageResource | A reference to the change message for the attributed data provided by the contributor. | string |
| extensionElement | - | object |
ChildAndParentsRelationship
The FamilySearch-proprietary model for a relationship between a child and a pair of parents.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| lang | The language of the conclusion. See http://www.w3.org/International/articles/language-tags/ | string |
| confidence | - | ConfidenceLevel |
| attribution | - | Attribution |
| analysis | - | ResourceReference |
| sortKey | A sort key in relation to other facts for display purposes. | string |
| extracted | Whether this subject has been identified as 'extracted', meaning it captures information extracted from a single source. | boolean |
| media | References to multimedia resources associated with this subject. | array of SourceReference |
| evidence | References to the evidence being referenced for this subject. | array of EvidenceReference |
| parent1 | - | ResourceReference |
| parent2 | - | ResourceReference |
| child | - | ResourceReference |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| sources | The source references for a conclusion. | array of SourceReference |
| notes | Notes about a person. | array of Note |
| identifiers | The list of identifiers for the subject. | array |
| parent1Facts | The fact conclusions for parent1. | array of Fact |
| parent2Facts | The fact conclusions for parent2. | array of Fact |
CitationField
Represents a citation field -- its name and value.
Type: object
| Name | Description | Type |
|---|---|---|
| name | The citation field's name. | string |
| value | The citation field's value. | string |
Collection
A collection of genealogical resources.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| lang | The language of this description of the collection. | string |
| content | Descriptions of the content of this collection. | array of CollectionContent |
| title | A title for the collection. | string |
| size | The size of the collection, in terms of the number of items in this collection. Format: int32 | integer |
| attribution | - | Attribution |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| identifiers | The list of identifiers for the source. | array |
CollectionContent
A description of the content of a collection by resource type.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| resourceType | - | ResourceType |
| count | The count of the items applicable to this content aspect. Format: int32 | integer |
| completeness | A completeness factor for this content; i.e. what percentage of the total number of items in the collection is included in this content aspect. The completeness factor is a value between 0 and 1. Format: float | number |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
Comment
A comment.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| text | The text of the comment. | string |
| contributor | - | ResourceReference |
| created | The date the comment was created. Format: date-time | string |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
ConfidenceLevel
The level of confidence the contributor has about the data.
Type: string
Enum:
http://gedcomx.org/Highhttp://gedcomx.org/Mediumhttp://gedcomx.org/Low
Coverage
A description of the coverage of a resource.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| spatial | - | PlaceReference |
| temporal | - | Date |
| recordType | - | RecordType |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
Date
A concluded genealogical date.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| original | The original text as supplied by the user. | string |
| formal | The standardized and/or normalized formal value. | string |
| confidence | - | ConfidenceLevel |
| extensionElement | - | object |
| fields | - | array of Field |
| normalized | - | array of TextValue |
Discussion
A discussion.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| title | The one-line summary or "subject" of the discussion. | string |
| details | The detailed text of the discussion. | string |
| contributor | - | ResourceReference |
| created | The date the discussion was created. Format: date-time | string |
| modified | Last date of any change to comments or discussion details. Format: date-time | string |
| numberOfComments | The number of comments associated with this discussion. Format: int32 | integer |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| comments | The comments on this discussion. | array of Comment |
DisplayProperties
A set of display properties for the convenience of quick display, such as for a Web-based application. All display properties are provided in the default locale for the current application context and are NOT considered canonical for the purposes of data exchange.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| name | The displayable name of the person. | string |
| gender | The displayable label for the gender of the person. | string |
| lifespan | The displayable label for the lifespan of the person. | string |
| birthDate | The displayable label for the birth date of the person. | string |
| birthPlace | The displayable label for the birth place of the person. | string |
| deathDate | The displayable label for the death date of the person. | string |
| deathPlace | The displayable label for the death place of the person. | string |
| marriageDate | The displayable label for the marriage date of the person. | string |
| marriagePlace | The displayable label for the marriage place of the person. | string |
| ascendancyNumber | The context-specific ascendancy number for the person in relation to the other persons in the request. The ancestry number is defined using the Ahnentafel numbering system. | string |
| descendancyNumber | The context-specific descendancy number for the person in relation to the other persons in the request. The descendancy number is defined using the d'Aboville numbering system. | string |
| relationshipDescription | The context-specific relationship description for the person in relation to the root person in the request. | string |
| role | The role of this person in the current display context. | string |
| extensionElement | - | object |
| familiesAsParent | The family views where this person is a parent. | array of FamilyView |
| familiesAsChild | The family views where this person is a child. | array of FamilyView |
Document
An abstract document that contains derived (conclusionary) text -- for example, a transcription or researcher analysis.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| lang | The language of the conclusion. See http://www.w3.org/International/articles/language-tags/ | string |
| confidence | - | ConfidenceLevel |
| attribution | - | Attribution |
| analysis | - | ResourceReference |
| sortKey | A sort key in relation to other facts for display purposes. | string |
| extracted | Whether this document has been identified as "extracted", meaning it captures information extracted from a single source. | boolean |
| type | - | DocumentType |
| textType | The text type of the document. | string |
| text | The document text. | string |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| sources | The source references for a conclusion. | array of SourceReference |
| notes | Notes about a person. | array of Note |
DocumentType
DocumentType
Type: string
Enum:
http://gedcomx.org/Abstracthttp://gedcomx.org/Translationhttp://gedcomx.org/Transcriptionhttp://gedcomx.org/Analysis
Event
A historical event.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| lang | The language of the conclusion. See http://www.w3.org/International/articles/language-tags/ | string |
| confidence | - | ConfidenceLevel |
| attribution | - | Attribution |
| analysis | - | ResourceReference |
| sortKey | A sort key in relation to other facts for display purposes. | string |
| extracted | Whether this subject has been identified as 'extracted', meaning it captures information extracted from a single source. | boolean |
| media | References to multimedia resources associated with this subject. | array of SourceReference |
| evidence | References to the evidence being referenced for this subject. | array of EvidenceReference |
| type | - | EventType |
| date | - | Date |
| place | - | PlaceReference |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| sources | The source references for a conclusion. | array of SourceReference |
| notes | Notes about a person. | array of Note |
| identifiers | The list of identifiers for the subject. | array |
| roles | The roles played in this event. | array of EventRole |
EventRole
A role that a specific person plays in an event.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| lang | The language of the conclusion. See http://www.w3.org/International/articles/language-tags/ | string |
| confidence | - | ConfidenceLevel |
| attribution | - | Attribution |
| analysis | - | ResourceReference |
| sortKey | A sort key in relation to other facts for display purposes. | string |
| person | - | ResourceReference |
| type | - | EventRoleType |
| details | Details about the role of the person in the event. | string |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| sources | The source references for a conclusion. | array of SourceReference |
| notes | Notes about a person. | array of Note |
EventRoleType
EventRoleType
Type: string
Enum:
http://gedcomx.org/Principalhttp://gedcomx.org/Participanthttp://gedcomx.org/Officialhttp://gedcomx.org/Witness
EventType
EventType
Type: string
Enum:
http://gedcomx.org/Adoptionhttp://gedcomx.org/AdultChristeninghttp://gedcomx.org/Annulmenthttp://gedcomx.org/Baptismhttp://gedcomx.org/BarMitzvahhttp://gedcomx.org/BatMitzvahhttp://gedcomx.org/Birthhttp://gedcomx.org/Blessinghttp://gedcomx.org/Burialhttp://gedcomx.org/Censushttp://gedcomx.org/Christeninghttp://gedcomx.org/Circumcisionhttp://gedcomx.org/Confirmationhttp://gedcomx.org/Cremationhttp://gedcomx.org/Deathhttp://gedcomx.org/Divorcehttp://gedcomx.org/DivorceFilinghttp://gedcomx.org/Educationhttp://gedcomx.org/Engagementhttp://gedcomx.org/Emigrationhttp://gedcomx.org/Enslavementhttp://gedcomx.org/Excommunicationhttp://gedcomx.org/FirstCommunionhttp://gedcomx.org/Funeralhttp://gedcomx.org/Immigrationhttp://gedcomx.org/Inquesthttp://gedcomx.org/LandTransactionhttp://gedcomx.org/Marriagehttp://gedcomx.org/MilitaryAwardhttp://gedcomx.org/MilitaryDischargehttp://gedcomx.org/Missionhttp://gedcomx.org/MoveFromhttp://gedcomx.org/MoveTohttp://gedcomx.org/Naturalizationhttp://gedcomx.org/Ordinationhttp://gedcomx.org/Retirement
EvidenceReference
A reference to a resource that is being used as evidence.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| resource | The URI to the resource being referenced as evidence. | string |
| resourceId | The resource id of the resource being referenced. Used as an extension attribute when resolving the resource is inconvenient. | string |
| attribution | - | Attribution |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
Fact
A conclusion about a fact applicable to a person or relationship.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| lang | The language of the conclusion. See http://www.w3.org/International/articles/language-tags/ | string |
| confidence | - | ConfidenceLevel |
| attribution | - | Attribution |
| analysis | - | ResourceReference |
| sortKey | A sort key in relation to other facts for display purposes. | string |
| type | - | FactType |
| date | - | Date |
| place | - | PlaceReference |
| value | The value as supplied by the user. | string |
| primary | Indicator of whether this fact is the "primary" fact of the record from which the subject was extracted. Applicable only to extracted persons/relationships. The meaning of this flag outside the scope of an extracted subject is undefined. | boolean |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| sources | The source references for a conclusion. | array of SourceReference |
| notes | Notes about a person. | array of Note |
| qualifiers | The qualifiers associated with this fact. | array of Qualifier |
| fields | - | array of Field |
FactType
FactType
Type: string
Enum:
http://gedcomx.org/Adoptionhttp://gedcomx.org/AdultChristeninghttp://gedcomx.org/Amnestyhttp://gedcomx.org/Apprenticeshiphttp://gedcomx.org/Arresthttp://gedcomx.org/Awardhttp://gedcomx.org/Baptismhttp://gedcomx.org/BarMitzvahhttp://gedcomx.org/BatMitzvahhttp://gedcomx.org/Birthhttp://gedcomx.org/BirthNoticehttp://gedcomx.org/Blessinghttp://gedcomx.org/Branchhttp://gedcomx.org/Burialhttp://gedcomx.org/Castehttp://gedcomx.org/Censushttp://gedcomx.org/Christeninghttp://gedcomx.org/Circumcisionhttp://gedcomx.org/Clanhttp://gedcomx.org/Confirmationhttp://gedcomx.org/Courthttp://gedcomx.org/Cremationhttp://gedcomx.org/Deathhttp://gedcomx.org/Educationhttp://gedcomx.org/EducationEnrollmenthttp://gedcomx.org/Emigrationhttp://gedcomx.org/Enslavementhttp://gedcomx.org/Ethnicityhttp://gedcomx.org/Excommunicationhttp://gedcomx.org/FirstCommunionhttp://gedcomx.org/Funeralhttp://gedcomx.org/GenderChangehttp://gedcomx.org/Graduationhttp://gedcomx.org/Heimathttp://gedcomx.org/Immigrationhttp://gedcomx.org/Imprisonmenthttp://gedcomx.org/Inquesthttp://gedcomx.org/LandTransactionhttp://gedcomx.org/Languagehttp://gedcomx.org/Livinghttp://gedcomx.org/MaritalStatushttp://gedcomx.org/Medicalhttp://gedcomx.org/MilitaryAwardhttp://gedcomx.org/MilitaryDischargehttp://gedcomx.org/MilitaryDraftRegistrationhttp://gedcomx.org/MilitaryInductionhttp://gedcomx.org/MilitaryServicehttp://gedcomx.org/Missionhttp://gedcomx.org/MoveFromhttp://gedcomx.org/MoveTohttp://gedcomx.org/MultipleBirthhttp://gedcomx.org/NationalIdhttp://gedcomx.org/Nationalityhttp://gedcomx.org/Naturalizationhttp://gedcomx.org/NumberOfMarriageshttp://gedcomx.org/Obituaryhttp://gedcomx.org/Occupationhttp://gedcomx.org/Ordinationhttp://gedcomx.org/Pardonhttp://gedcomx.org/PhysicalDescriptionhttp://gedcomx.org/Probatehttp://gedcomx.org/Propertyhttp://gedcomx.org/Racehttp://gedcomx.org/Religionhttp://gedcomx.org/Residencehttp://gedcomx.org/Retirementhttp://gedcomx.org/Stillbirthhttp://gedcomx.org/TaxAssessmenthttp://gedcomx.org/Tribehttp://gedcomx.org/Willhttp://gedcomx.org/Visithttp://gedcomx.org/Yahrzeithttp://gedcomx.org/Annulmenthttp://gedcomx.org/CommonLawMarriagehttp://gedcomx.org/CivilUnionhttp://gedcomx.org/Divorcehttp://gedcomx.org/DivorceFilinghttp://gedcomx.org/DomesticPartnershiphttp://gedcomx.org/Engagementhttp://gedcomx.org/Marriagehttp://gedcomx.org/MarriageBannshttp://gedcomx.org/MarriageContracthttp://gedcomx.org/MarriageLicensehttp://gedcomx.org/MarriageNoticehttp://gedcomx.org/NumberOfChildrenhttp://gedcomx.org/Separationhttp://gedcomx.org/AdoptiveParenthttp://gedcomx.org/BiologicalParenthttp://gedcomx.org/FosterParenthttp://gedcomx.org/GuardianParenthttp://gedcomx.org/StepParenthttp://gedcomx.org/SociologicalParenthttp://gedcomx.org/SurrogateParent
FamilySearchPlatform
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.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| lang | 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. | string |
| attribution | - | Attribution |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| description | A reference to a description of this data set. | string |
| persons | The persons included in this genealogical data set. | array of Person |
| relationships | The relationships included in this genealogical data set. | array of Relationship |
| sourceDescriptions | The descriptions of sources included in this genealogical data set. | array of SourceDescription |
| agents | The agents included in this genealogical data set. | array of Agent |
| events | The events included in this genealogical data set. | array of Event |
| places | The places included in this genealogical data set. | array of PlaceDescription |
| documents | The documents included in this genealogical data set. | array of Document |
| collections | The collections included in this genealogical data set. | array of Collection |
| fields | - | array of Field |
| recordDescriptors | The record descriptors included in this genealogical data set. | array of RecordDescriptor |
| mergeAnalyses | The merge analysis results for this data set. | array of MergeAnalysis |
| merges | The merges for this data set. | array of Merge |
| childAndParentsRelationships | The child-and-parents relationships. | array of ChildAndParentsRelationship |
| discussions | The discussions included in this data set. | array of Discussion |
| groups | The groups included in this data set. | array of Group |
| trees | The trees included in this data set. | array of Tree |
| users | The users included in this data set. | array of User |
| features | The set of features defined in the platform API. | array of Feature |
| vocabConcepts | The vocabulary concepts included in this data set. | array of VocabConcept |
FamilyView
A family view, meaning up to two parents and a list of children who have those parents in common. Relationships carry the canonical information for this view, and the relationships must be used to get Facts (lineage types, marriages, etc.) about the relationships covered by a Family. The Family data type provides a convenient way to see the typical family views without having to do the calculations to derive them. There should only be one family for each unique set of parents, and only one for each single-parent family with a particular parent.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| parent1 | - | ResourceReference |
| parent2 | - | ResourceReference |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| children | A list of references to the children of this family. | array of ResourceReference |
Feature
A description of a FamilySearch feature.
Type: object
| Name | Description | Type |
|---|---|---|
| name | The name of the feature. | string |
| description | A description of the feature. | string |
| enabled | True if the feature is enabled for the current request: false otherwise. | boolean |
| activationDate | The date that this feature is scheduled to be enabled permanently. Format: date-time | string |
Field
A field of a record.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| lang | The language of the conclusion. See http://www.w3.org/International/articles/language-tags/ | string |
| confidence | - | ConfidenceLevel |
| attribution | - | Attribution |
| analysis | - | ResourceReference |
| sortKey | A sort key in relation to other facts for display purposes. | string |
| type | - | FieldType |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| sources | The source references for a conclusion. | array of SourceReference |
| notes | Notes about a person. | array of Note |
| values | The set of values for the field. | array of FieldValue |
FieldDescriptor
A description of a field in a record.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| originalLabel | The original label for the field, as stated on the original record. | string |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| descriptions | Localized description of this field. | array of TextValue |
| values | Localized display labels for the field values. | array of FieldValueDescriptor |
FieldType
FieldType
Type: string
Enum:
http://gedcomx.org/Agehttp://gedcomx.org/Datehttp://gedcomx.org/Placehttp://gedcomx.org/Genderhttp://gedcomx.org/Namehttp://gedcomx.org/Rolehttp://gedcomx.org/Yearshttp://gedcomx.org/Monthshttp://gedcomx.org/Dayshttp://gedcomx.org/Hourshttp://gedcomx.org/Minuteshttp://gedcomx.org/Yearhttp://gedcomx.org/Monthhttp://gedcomx.org/Dayhttp://gedcomx.org/Hourhttp://gedcomx.org/Minutehttp://gedcomx.org/Addresshttp://gedcomx.org/Cemeteryhttp://gedcomx.org/Cityhttp://gedcomx.org/Churchhttp://gedcomx.org/Countyhttp://gedcomx.org/Countryhttp://gedcomx.org/Districthttp://gedcomx.org/Hospitalhttp://gedcomx.org/Islandhttp://gedcomx.org/MilitaryBasehttp://gedcomx.org/Mortuaryhttp://gedcomx.org/Parishhttp://gedcomx.org/PlotNumberhttp://gedcomx.org/PostOfficehttp://gedcomx.org/PostalCodehttp://gedcomx.org/Prisonhttp://gedcomx.org/Provincehttp://gedcomx.org/Sectionhttp://gedcomx.org/Shiphttp://gedcomx.org/Statehttp://gedcomx.org/Territoryhttp://gedcomx.org/Townhttp://gedcomx.org/Townshiphttp://gedcomx.org/Wardhttp://gedcomx.org/Prefixhttp://gedcomx.org/Suffixhttp://gedcomx.org/Givenhttp://gedcomx.org/Surnamehttp://gedcomx.org/Abusuahttp://gedcomx.org/BatchNumberhttp://gedcomx.org/Castehttp://gedcomx.org/Clanhttp://gedcomx.org/CommonLawMarriagehttp://gedcomx.org/Educationhttp://gedcomx.org/Ethnicityhttp://gedcomx.org/FatherBirthPlacehttp://gedcomx.org/NeverHadChildrenhttp://gedcomx.org/NeverMarriedhttp://gedcomx.org/NumberOfChildrenhttp://gedcomx.org/NumberOfMarriageshttp://gedcomx.org/Householdhttp://gedcomx.org/IsHeadOfHouseholdhttp://gedcomx.org/MaritalStatushttp://gedcomx.org/MotherBirthPlacehttp://gedcomx.org/MultipleBirthhttp://gedcomx.org/NameSakehttp://gedcomx.org/NationalIdhttp://gedcomx.org/Nationalityhttp://gedcomx.org/Occupationhttp://gedcomx.org/PhysicalDescriptionhttp://gedcomx.org/Propertyhttp://gedcomx.org/Racehttp://gedcomx.org/Religionhttp://gedcomx.org/RelationshipToHeadhttp://gedcomx.org/Stillbirthhttp://gedcomx.org/TitleOfNobilityhttp://gedcomx.org/Tribe
FieldValue
An element representing a value in a record field.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| lang | The language of the conclusion. See http://www.w3.org/International/articles/language-tags/ | string |
| confidence | - | ConfidenceLevel |
| attribution | - | Attribution |
| analysis | - | ResourceReference |
| sortKey | A sort key in relation to other facts for display purposes. | string |
| type | - | FieldValueType |
| labelId | The id of the label applicable to this field value. | string |
| text | The text value. | string |
| datatype | The datatype of the text value of the field. | string |
| resource | URI that resolves to the value of the field. | string |
| status | - | FieldValueStatusType |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| sources | The source references for a conclusion. | array of SourceReference |
| notes | Notes about a person. | array of Note |
FieldValueDescriptor
A way a field is to be displayed to a user.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| labelId | The id of the label applicable to the field value. | string |
| type | The type of the field value. | string |
| optional | Whether the treatment of the field value is optional. Used to determine whether it should be displayed even if the value is empty. | boolean |
| displaySortKey | A sort key for sorting this field value relative to other field values according to how they should be displayed for viewing. | string |
| entrySortKey | A sort key for sorting this field value relative to other field values according to how they should be entered for editing. | string |
| entryRequired | Whether some kind of entry is required when entering data for editing. | boolean |
| editable | Whether the field value is editable. Some field values might be composed from other field values or otherwise calculated by the system. | boolean |
| parentLabelId | The id of the label for the "parent" field value. For example, the parent field value of a "given name" field value might be the "name" field value. | string |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| labels | The labels to be used for display purposes. | array of TextValue |
| entryLabels | The labels to be used for entry purposes. | array of TextValue |
FieldValueStatusType
FieldValueStatusType
Type: string
Enum:
http://gedcomx.org/Blankhttp://gedcomx.org/Unreadable
FieldValueType
FieldValueType
Type: string
Enum:
http://gedcomx.org/Originalhttp://gedcomx.org/Interpreted
Gedcomx
The GEDCOM X data formats define the serialization formats of the GEDCOM X conceptual model.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| lang | 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. | string |
| attribution | - | Attribution |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| description | A reference to a description of this data set. | string |
| persons | The persons included in this genealogical data set. | array of Person |
| relationships | The relationships included in this genealogical data set. | array of Relationship |
| sourceDescriptions | The descriptions of sources included in this genealogical data set. | array of SourceDescription |
| agents | The agents included in this genealogical data set. | array of Agent |
| events | The events included in this genealogical data set. | array of Event |
| places | The places included in this genealogical data set. | array of PlaceDescription |
| documents | The documents included in this genealogical data set. | array of Document |
| collections | The collections included in this genealogical data set. | array of Collection |
| fields | - | array of Field |
| recordDescriptors | The record descriptors included in this genealogical data set. | array of RecordDescriptor |
Gender
A gender conclusion.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| lang | The language of the conclusion. See http://www.w3.org/International/articles/language-tags/ | string |
| confidence | - | ConfidenceLevel |
| attribution | - | Attribution |
| analysis | - | ResourceReference |
| sortKey | A sort key in relation to other facts for display purposes. | string |
| type | - | GenderType |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| sources | The source references for a conclusion. | array of SourceReference |
| notes | Notes about a person. | array of Note |
| fields | - | array of Field |
GenderType
GenderType
Type: string
Enum:
http://gedcomx.org/Malehttp://gedcomx.org/Femalehttp://gedcomx.org/Unknown
Group
The Group
Type: object
| Name | Description | Type |
|---|---|---|
| id | The group id. | string |
| name | The group name. | string |
| description | The group description. | string |
| codeOfConduct | The group code of conduct. | string |
| treeIds | The ids of the trees associated with the group. | array |
| members | The members of the group. | array of GroupMember |
GroupMember
A Member of a Group
Type: object
| Name | Description | Type |
|---|---|---|
| groupId | The id of the group. | string |
| cisId | The cisId of the group member. | string |
| contactName | The contact name of the group member. | string |
| status | The status of the group member. | string |
InputStreamResource
Type: object
| Name | Description | Type |
|---|---|---|
| description | - | string |
| open | - | boolean |
| inputStream | - | object |
| file | Format: binary | string |
| readable | - | boolean |
| url | Format: url | string |
| filename | - | string |
| uri | Format: uri | string |
| contentAsByteArray | Format: byte | string |
Link
A link.
Type: object
| Name | Description | Type |
|---|---|---|
| href | The target URI of the link. | string |
| template | A URI template per RFC 6570, used to link to a range of URIs, such as for the purpose of linking to a query. | string |
| type | Metadata about the available media type(s) of the resource being linked to. The value of the "type" attribute is as defined by the HTTP specification, RFC 2616, Section 3.7. Note that this attribute can be considered an "Update Control (CU)" per Amundsen, M. (2011). Hypermedia APIs with HTML5 and Node. O'Reilly. | string |
| accept | Metadata about the available media type(s) of the resource being linked to update (i.e. change the state of) the resource being linked to. The value of the "accept" attribute is as defined by the HTTP specification, RFC 2616, Section 3.7. Note that this attribute can be considered an "Read Control (CR)" per Amundsen, M. (2011). Hypermedia APIs with HTML5 and Node. O'Reilly. | string |
| allow | Metadata about the allowable methods that can be used to transition to the resource being linked. The value of the "allow" attribute is as defined by the HTTP specification, RFC 2616, Section 14.7. Note that this attribute can be considered an "Method Control (CM)" per Amundsen, M. (2011). Hypermedia APIs with HTML5 and Node. O'Reilly. | string |
| hreflang | The language of the resource being linked to. Note that this attribute can be considered an "Update Control (CU)" per Amundsen, M. (2011). Hypermedia APIs with HTML5 and Node. O'Reilly. | string |
| title | Human-readable information about the link. | string |
| count | The number of elements in the page, if this link refers to a page of resources. Format: int32 | integer |
| offset | The index of the offset of the page, if this link refers to a page of resources. Format: int32 | integer |
| results | The total number of results in the page to which this links, if this link refers to a page of resources. Format: int32 | integer |
MediaType
Type: object
| Name | Description | Type |
|---|---|---|
| type | - | string |
| subtype | - | string |
| parameters | - | object |
| qualityValue | Format: double | number |
| subtypeSuffix | - | string |
| wildcardSubtype | - | boolean |
| wildcardType | - | boolean |
| concrete | - | boolean |
| charset | - | object |
MemoriesArtifactItem
Type: object
| Name | Description | Type |
|---|---|---|
| artifact | - | object |
| description | - | SourceDescription |
| personas | - | array of MemoriesPersona |
| metadata | - | ArtifactMetadata |
MemoriesPersona
Type: object
| Name | Description | Type |
|---|---|---|
| tags | - | array of MemoriesTag |
| person | - | Person |
MemoriesTag
Type: object
| Name | Description | Type |
|---|---|---|
| id | - | string |
| title | - | string |
| x | Format: float | number |
| y | Format: float | number |
| width | Format: float | number |
| height | Format: float | number |
Merge
A merge.
Type: object
| Name | Description | Type |
|---|---|---|
| resourcesToDelete | List of resources to remove from the survivor person. | array of ResourceReference |
| resourcesToCopy | List of resources to copy from the duplicate person to survivor person. | array of ResourceReference |
MergeAnalysis
A merge analysis.
Type: object
| Name | Description | Type |
|---|---|---|
| survivorResources | List of survivor resources. | array of ResourceReference |
| duplicateResources | List of duplicate resources. | array of ResourceReference |
| conflictingResources | List of resources that are in conflict. | array of MergeConflict |
| survivor | - | ResourceReference |
| duplicate | - | ResourceReference |
MergeConflict
A merge conflict.
Type: object
| Name | Description | Type |
|---|---|---|
| survivorResource | - | ResourceReference |
| duplicateResource | - | ResourceReference |
Name
A name conclusion.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| lang | The language of the conclusion. See http://www.w3.org/International/articles/language-tags/ | string |
| confidence | - | ConfidenceLevel |
| attribution | - | Attribution |
| analysis | - | ResourceReference |
| sortKey | A sort key in relation to other facts for display purposes. | string |
| type | - | NameType |
| date | - | Date |
| preferred | Whether the conclusion is preferred above other conclusions of the same type. Useful, for example, for display purposes. | boolean |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| sources | The source references for a conclusion. | array of SourceReference |
| notes | Notes about a person. | array of Note |
| nameForms | Alternate forms of the name, such as the romanized form of a non-latin name. | array of NameForm |
NameForm
A form of a name.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| lang | The language of the conclusion. See http://www.w3.org/International/articles/language-tags/ | string |
| fullText | The full text of the name form. | string |
| extensionElement | - | object |
| parts | The different parts of the name form. | array of NamePart |
| fields | - | array of Field |
NamePart
A part of a name.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| type | - | NamePartType |
| value | The value of the name part. | string |
| extensionElement | - | object |
| qualifiers | The qualifiers associated with this name part. | array of Qualifier |
| fields | - | array of Field |
NamePartType
NamePartType
Type: string
Enum:
http://gedcomx.org/Prefixhttp://gedcomx.org/Suffixhttp://gedcomx.org/Givenhttp://gedcomx.org/Surname
NameType
NameType
Type: string
Enum:
http://gedcomx.org/BirthNamehttp://gedcomx.org/DeathNamehttp://gedcomx.org/MarriedNamehttp://gedcomx.org/AlsoKnownAshttp://gedcomx.org/Nicknamehttp://gedcomx.org/AdoptiveNamehttp://gedcomx.org/FormalNamehttp://gedcomx.org/ReligiousName
Note
A note about a genealogical resource (e.g. conclusion or source).
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| lang | The language of the note. See http://www.w3.org/International/articles/language-tags/ | string |
| subject | The subject of the note. This is a short title describing the contents of the note text. | string |
| text | The text of the note. | string |
| attribution | - | Attribution |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
OnlineAccount
An online account for a web application.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| serviceHomepage | - | ResourceReference |
| accountName | The name associated the holder of this account with the account. | string |
| extensionElement | - | object |
Person
A person.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| lang | The language of the conclusion. See http://www.w3.org/International/articles/language-tags/ | string |
| confidence | - | ConfidenceLevel |
| attribution | - | Attribution |
| analysis | - | ResourceReference |
| sortKey | A sort key in relation to other facts for display purposes. | string |
| extracted | Whether this subject has been identified as 'extracted', meaning it captures information extracted from a single source. | boolean |
| media | References to multimedia resources associated with this subject. | array of SourceReference |
| evidence | References to the evidence being referenced for this subject. | array of EvidenceReference |
| living | Living status of the person as treated by the system. The value of this property is intended to be based on a system-specific calculation and therefore has limited portability. Conclusions about the living status of a person can be modeled with a fact. | boolean |
| principal | Indicator of whether this person is the 'principal' person extracted from the record. Applicable only to extracted persons. The meaning of this flag outside the scope of an extracted person is undefined. | boolean |
| gender | - | Gender |
| private | - | boolean |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| sources | The source references for a conclusion. | array of SourceReference |
| notes | Notes about a person. | array of Note |
| identifiers | The list of identifiers for the subject. | array |
| names | The name conclusions for the person. | array of Name |
| facts | The fact conclusions for the person. | array of Fact |
| fields | - | array of Field |
| display | - | DisplayProperties |
PlaceAttribute
Type: object
| Name | Description | Type |
|---|---|---|
| attributeId | - | string |
| typeName | - | string |
| typeId | - | string |
| descriptionId | - | string |
| value | - | string |
| year | Format: int32 | integer |
| locale | - | string |
PlaceDescription
A PlaceDescription is used to describe the details of a place in terms of its name and possibly its type, time period, and/or a geospatial description -- a description of a place as a snapshot in time.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| lang | The language of the conclusion. See http://www.w3.org/International/articles/language-tags/ | string |
| confidence | - | ConfidenceLevel |
| attribution | - | Attribution |
| analysis | - | ResourceReference |
| sortKey | A sort key in relation to other facts for display purposes. | string |
| extracted | Whether this subject has been identified as 'extracted', meaning it captures information extracted from a single source. | boolean |
| media | References to multimedia resources associated with this subject. | array of SourceReference |
| evidence | References to the evidence being referenced for this subject. | array of EvidenceReference |
| type | An implementation-specific uniform resource identifier (URI) used to identify the type of a place (e.g., address, city, county, province, state, country, etc.). | string |
| temporalDescription | - | Date |
| latitude | Degrees north or south of the Equator (0.0 degrees). Values range from −90.0 degrees (south) to 90.0 degrees (north). Format: double | number |
| longitude | Angular distance in degrees, relative to the Prime Meridian. Values range from −180.0 degrees (west of the Meridian) to 180.0 degrees (east of the Meridian). Format: double | number |
| place | - | ResourceReference |
| spatialDescription | - | ResourceReference |
| jurisdiction | - | ResourceReference |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| sources | The source references for a conclusion. | array of SourceReference |
| notes | Notes about a person. | array of Note |
| identifiers | The list of identifiers for the subject. | array |
| names | An ordered list of standardized (or normalized), fully-qualified (in terms of what is known of the applicable jurisdictional hierarchy) names for this place that are applicable to this description of this place. The list MUST include at least one value. It is RECOMMENDED that instances include a single name and any equivalents from other cultural contexts; name variants should more typically be described in separate PlaceDescription instances. The list is assumed to be given in order of preference, with the most preferred value in the first position in the list. | array of TextValue |
| display | - | PlaceDisplayProperties |
PlaceDisplayProperties
A set of display properties for places for the convenience of quick display, such as for a Web-based application. All display properties are provided in the default locale for the current application context and are NOT considered canonical for the purposes of data exchange.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| name | The displayable name of the place. | string |
| fullName | The displayable full name of the place. | string |
| type | The displayable type of the place. | string |
| extensionElement | - | object |
PlaceReference
A reference to genealogical place.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| original | The original value as supplied by the user. | string |
| confidence | - | ConfidenceLevel |
| extensionElement | - | object |
| description | A reference to a description of the place being referenced. | string |
| fields | - | array of Field |
| normalized | - | array of TextValue |
Qualifier
A data qualifier. Qualifiers are used to "qualify" certain data elements to provide additional context, information, or details.
Type: object
| Name | Description | Type |
|---|---|---|
| value | The value of the qualifier. Some qualifiers may not have values, indicating that the qualifier is to be treated more like a "tag". | string |
| name | The name of the qualifier. The name should be an element of a constrained vocabulary and is used to determine meaning of the qualifier. | string |
RecordDescriptor
A descriptor for a common set of records.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| lang | The language of this record description. | string |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| fields | Descriptors of the fields that are applicable to this record. | array of FieldDescriptor |
RecordType
RecordType
Type: string
Enum:
http://gedcomx.org/Admissionhttp://gedcomx.org/Adoptionhttp://gedcomx.org/Affidavithttp://gedcomx.org/Applicationhttp://gedcomx.org/Arrivalhttp://gedcomx.org/Bankhttp://gedcomx.org/Baptismhttp://gedcomx.org/Birthhttp://gedcomx.org/Burialhttp://gedcomx.org/Businesshttp://gedcomx.org/Cemeteryhttp://gedcomx.org/Censushttp://gedcomx.org/Christeninghttp://gedcomx.org/CompiledGenealogyhttp://gedcomx.org/Confirmationhttp://gedcomx.org/Correspondencehttp://gedcomx.org/Deathhttp://gedcomx.org/Departurehttp://gedcomx.org/Divorcehttp://gedcomx.org/Duplicatehttp://gedcomx.org/Drafthttp://gedcomx.org/Estatehttp://gedcomx.org/Indexhttp://gedcomx.org/IntendedMarriagehttp://gedcomx.org/Landhttp://gedcomx.org/Legalhttp://gedcomx.org/Marriagehttp://gedcomx.org/MarriageAffidavithttp://gedcomx.org/MarriageAmendmenthttp://gedcomx.org/MarriageBannshttp://gedcomx.org/MarriageConsenthttp://gedcomx.org/MarriageDuplicatehttp://gedcomx.org/MarriageLicensehttp://gedcomx.org/MarriageReturnshttp://gedcomx.org/Membershiphttp://gedcomx.org/Migrationhttp://gedcomx.org/Militaryhttp://gedcomx.org/Naturalizationhttp://gedcomx.org/Newspaperhttp://gedcomx.org/Obituaryhttp://gedcomx.org/Passengerhttp://gedcomx.org/Pensionhttp://gedcomx.org/Probatehttp://gedcomx.org/RelatedDocumenthttp://gedcomx.org/ReligiousCreedshttp://gedcomx.org/Residencehttp://gedcomx.org/Rollhttp://gedcomx.org/Taxhttp://gedcomx.org/Vitalhttp://gedcomx.org/VoterRegistrationhttp://gedcomx.org/Will
Relationship
A relationship between two or more persons.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| lang | The language of the conclusion. See http://www.w3.org/International/articles/language-tags/ | string |
| confidence | - | ConfidenceLevel |
| attribution | - | Attribution |
| analysis | - | ResourceReference |
| sortKey | A sort key in relation to other facts for display purposes. | string |
| extracted | Whether this subject has been identified as 'extracted', meaning it captures information extracted from a single source. | boolean |
| media | References to multimedia resources associated with this subject. | array of SourceReference |
| evidence | References to the evidence being referenced for this subject. | array of EvidenceReference |
| type | - | RelationshipType |
| person1 | - | ResourceReference |
| person2 | - | ResourceReference |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| sources | The source references for a conclusion. | array of SourceReference |
| notes | Notes about a person. | array of Note |
| identifiers | The list of identifiers for the subject. | array |
| facts | The fact conclusions for the relationship. | array of Fact |
| fields | - | array of Field |
RelationshipType
RelationshipType
Type: string
Enum:
http://gedcomx.org/AncestorDescendanthttp://gedcomx.org/Couplehttp://gedcomx.org/EnslavedByhttp://gedcomx.org/Godparenthttp://gedcomx.org/ParentChild
ResourceReference
A generic reference to a resource.
Type: object
| Name | Description | Type |
|---|---|---|
| resource | The URI to the resource. For more information, see Architecture of the World Wide Web, Volume One, Section 2 | string |
| resourceId | The resource id of the resource being referenced. Used as an extension attribute when resolving the resource is inconvenient. | string |
ResourceType
ResourceType
Type: string
Enum:
http://gedcomx.org/Recordhttp://gedcomx.org/Collectionhttp://gedcomx.org/DigitalArtifacthttp://gedcomx.org/PhysicalArtifacthttp://gedcomx.org/Person
SourceCitation
Represents a source citation.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| lang | The language of the citation. See http://www.w3.org/International/articles/language-tags/ | string |
| value | A rendering (as a string) of a source citation. This rendering should be the most complete rendering available. | string |
| citationTemplate | - | ResourceReference |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| fields | The list of citation fields. | array of CitationField |
SourceDescription
Represents a description of a source.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| lang | 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. | string |
| mediaType | Hint about the media (MIME) type of the resource being described. | string |
| about | The URI (if applicable) of the actual source. | string |
| mediator | - | ResourceReference |
| publisher | - | ResourceReference |
| analysis | - | ResourceReference |
| componentOf | - | SourceReference |
| titleLabel | - | TextValue |
| attribution | - | Attribution |
| resourceType | - | ResourceType |
| sortKey | - | string |
| created | Format: date-time | string |
| modified | Format: date-time | string |
| coverage | - | array of Coverage |
| repository | - | ResourceReference |
| replacedBy | - | string |
| version | Gets the version of this resource | string |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| citations | The bibliographic citation for this source. | array of SourceCitation |
| authors | The authors for this source. | array |
| sources | References to any sources to which this source is related (usually applicable to sources that are derived from or contained in another source). | array of SourceReference |
| titles | A list of titles for this source. | array of TextValue |
| notes | Notes about a source. | array of Note |
| rights | The rights for this source. | array |
| descriptions | A list of descriptions for this source. | array of TextValue |
| identifiers | The list of identifiers for the agent. | array |
| fields | - | array of Field |
| descriptor | - | ResourceReference |
| replaces | - | array |
| statuses | The status of this source description. | array |
SourceReference
An attributable reference to a description of a source.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| attribution | - | Attribution |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
| description | A reference to a description of the source being referenced. | string |
| descriptionId | Id of the source being referenced. | string |
| qualifiers | The qualifiers associated with this source reference. | array of Qualifier |
TextValue
An element representing a text value that may be in a specific language.
Type: object
| Name | Description | Type |
|---|---|---|
| lang | The language of the text value. See http://www.w3.org/International/articles/language-tags/ | string |
| value | The text value. | string |
Tree
A tree.
Type: object
| Name | Description | Type |
|---|---|---|
| id | The tree id. | string |
| groupIds | The ids of the groups this tree belongs to. | array |
| name | The tree name. | string |
| description | The tree description. | string |
| startingPersonId | The tree starting person id. | string |
| hidden | The hidden state of the tree. | boolean |
| collectionId | The id of the collection the tree belongs to. | string |
| ownerAccess | The owner third party access state of the tree. | string |
| groupAccess | The group third party access state of the tree. | string |
| private | - | boolean |
User
Family Tree User Service User
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| contactName | The contact name of the user. | string |
| helperAccessPin | The helper access pin of the user. | string |
| fullName | The full name of the user. | string |
| givenName | The given name of the user. | string |
| familyName | The family name of the user. | string |
| The email of the user. | string | |
| alternateEmail | The alternate email of the user. | string |
| country | The country of the user. | string |
| gender | The gender of the user. | string |
| birthDate | The birth date of the user. | string |
| phoneNumber | The phone number of the user. | string |
| mobilePhoneNumber | The mobile phone number of the user. | string |
| mailingAddress | The mailing address of the user. | string |
| preferredLanguage | The preferred language of the user. | string |
| displayName | The display name of the user. | string |
| personId | The person id of the user. | string |
| treeUserId | The tree user id of the user. | string |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
VocabConcept
A vocabulary concept.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| description | The vocabulary concept description. | string |
| note | The vocabulary concept note. | string |
| gedcomxUri | The Gedcomx URI associated with the concept. | string |
| vocabTerms | The terms associated with the concept. | array of VocabTerm |
| attributes | The attributes associated with the concept. | array of VocabConceptAttribute |
| definitions | The definitions associated with the concept. | array of TextValue |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
VocabConceptAttribute
A vocabulary concept attribute.
Type: object
| Name | Description | Type |
|---|---|---|
| id | The vocabulary concept attribute id. | string |
| name | The vocabulary concept attribute name. | string |
| value | The vocabulary concept attribute value. | string |
VocabConcepts
A list of vocabulary concepts.
Type: object
| Name | Description | Type |
|---|---|---|
| vocabConcepts | The list of vocabulary concepts. | array of VocabConcept |
VocabElement
Representation of a vocabulary element
Type: object
| Name | Description | Type |
|---|---|---|
| id | The id of the element. | string |
| uri | The URI of the element. | string |
| subclass | The subclass of the element. | string |
| type | The type of the element. | string |
| labels | The labels of the element. | array of TextValue |
| descriptions | The descriptions of the element. | array of TextValue |
| sublist | The sublist of the element. | string |
| position | Format: int32 | integer |
| sortName | - | string |
VocabElementList
Representation of a list of VocabElement objects
Type: object
| Name | Description | Type |
|---|---|---|
| title | The title of the list of elements. | string |
| description | The description of the list of elements. | string |
| uri | The URI of the list of elements. | string |
| id | The id of the list of elements. | string |
| elements | The list of elements. | array of VocabElement |
VocabTerm
A vocabulary term.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| typeUri | The vocabulary term type. | string |
| sublistUri | The URI of the sublist this vocabulary term is associated with. | string |
| sublistPosition | The position of this vocabulary term within it's associated sublist. Format: int32 | integer |
| values | The values of the vocabulary term. | array of TextValue |
| vocabConcept | - | string |
| vocabConceptUri | - | string |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
VocabTranslation
A vocabulary translation.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| text | - | string |
| lang | - | string |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
Updated 1 day ago