XML

FieldDescriptor (JSON)

A description of a field in a record.

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

Properties

Name Type Description
originalLabel string The original label for the field, as stated on the original record. FTU
descriptions array of TextValue The description of the field. FTU
values array of FieldValueDescriptor Descriptors of the values that are applicable to the field. 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

{
  "originalLabel" : "...",
  "descriptions" : [ {
    "lang" : "...",
    "value" : "..."
  }, ... ],
  "values" : [ {
    "optional" : false,
    "type" : "...",
    "labelId" : "...",
    "labels" : [ {
    }, ... ],
    "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" : "..."
}