• Documentation >
• Data Formats >
• FamilyView

FamilyView (JSON)

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.

URI:	FamilyView
Extends:	HypermediaEnabledData

Properties

Name	Type	Description
parent1	ResourceReference	A reference to a parent in the family. The name "parent1" is used only to distinguish it from the other parent in this family and implies neither order nor role.
parent2	ResourceReference	A reference to a parent in the family. The name "parent2" is used only to distinguish it from the other parent in this family and implies neither order nor role.
children	array of ResourceReference	A list of references to the children of this family.
Properties inherited from HypermediaEnabledData
links	map 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

{
  "parent1" : {
    "resourceId" : "...",
    "resource" : "..."
  },
  "parent2" : {
    "resourceId" : "...",
    "resource" : "..."
  },
  "children" : [ {
    "resourceId" : "...",
    "resource" : "..."
  }, {
    "resourceId" : "...",
    "resource" : "..."
  } ],
  "links" : {
    "property1" : {
      "href" : "...",
      "template" : "...",
      "title" : "...",
      "type" : "...",
      "accept" : "...",
      "allow" : "...",
      "hreflang" : "...",
      "count" : 12345,
      "offset" : 12345,
      "results" : 12345
    },
    "property2" : {
      "href" : "...",
      "template" : "...",
      "title" : "...",
      "type" : "...",
      "accept" : "...",
      "allow" : "...",
      "hreflang" : "...",
      "count" : 12345,
      "offset" : 12345,
      "results" : 12345
    }
  },
  "id" : "..."
}