Read Vocabulary Concept V2
Read a vocabulary concept in V2 format. Returns a VocabConcepts wrapper containing a list of controlled vocabulary terms with their definitions and attributes for the specified concept id.
The scope of the terms returned can be limited by using the type query parameter. Multiple types may be requested by supplying a comma-separated list of types. All terms will be returned if this query parameter is omitted.
A Selection of Commonly Referenced Term Types:
| Type | Description |
|---|---|
| OFFICIAL | Official term for the concept (There is at most one, and there should always be one associated with a concept.) |
| OFFICIAL_PLURAL | The plural form of the official term (There is at most one, but is optional for a concept. May be the same text as OFFICIAL.) |
| ABBREVIATION | Abbreviation (Zero or more for the same concept.) |
| ALTERNATE | Variant name for the term (Zero or more for the same concept.) |
| CODE | Code representation of the term (Optionally supported by a concept.) |
V1 Response Format (Deprecated)
Note: This endpoint also supports V1 response formats via the following Accept headers:
- application/ld+json (JSON-LD V1)
- application/x-fs-v1+json (FamilySearch Platform V1 JSON)
- application/json (Generic JSON V1)
- application/rdf+xml (RDF/XML V1)
- application/x-fs-v1+xml (FamilySearch Platform V1 XML)
- application/xml (Generic XML V1)
The V1 format returns a single VocabConcept object and does not support the descendancy parameter.
V1 is considered deprecated. We strongly recommend that new applications use the V2 format (specified above with application/ld-v2+json or application/x-fs-v2+json Accept headers) which provides enhanced functionality including descendancy support.
Path parameters
The CV concept ID.
Query parameters
For each concept found, a list of terms will be returned. Use this parameter to limit what types of terms are returned.
If specified, returns the search result along with its descendent concepts with respective terms.
Headers
Specifies the media type(s) that the client is willing to accept in the response.
Response
The concept is available.