• Documentation >
• Data Formats >
• VocabTerm

VocabTerm (JSON)

A data type that supports hypermedia controls (i.e. links).

URI:	VocabTerm
Extends:	HypermediaEnabledData

Properties

Name	Type	Description
typeUri	string	Get the vocabulary term type.
vocabConcept	string	Get the URI of the vocabulary concept this vocabulary term is associated with.
sublistUri	string	Get the URI of the sublist this vocabulary term is associated with.
sublistPosition	number	Get the position of this vocabulary term within it's associated sublist.
values	array of TextValue	Get the vocabulary term values.
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

{
  "typeUri" : "...",
  "vocabConcept" : "...",
  "sublistUri" : "...",
  "sublistPosition" : 12345,
  "values" : [ {
    "lang" : "...",
    "value" : "..."
  }, {
    "lang" : "...",
    "value" : "..."
  } ],
  "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" : "..."
}