XML

FieldValueDescriptor (JSON)

A way a field is to be displayed to a user.

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

Properties

Name Type Description
optional boolean Whether the treatment of the field value is optional. Used to determine whether it should be displayed even if the value is empty. FTU
type fieldValueType The type of the field value. FTU
labelId string The id of the label applicable to the field value. FTU
labels array of TextValue The labels to be used for display purposes. 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

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