Read Controlled Vocabulary

This example request illustrates how to read the Controlled Vocabulary resource. The FamilySearch Controlled Vocabulary resource contains FamilySearch's set of vocabulary elements.

JSON

Request

GET /platform/collections/vocab
Accept: application/x-gedcomx-v1+json
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE

Response

HTTP/1.1 200 OK
Content-type: application/x-gedcomx-v1+json
X-processing-time: 3
Vary: Accept,Accept-Language,Accept-Encoding,Expect
Content-location: /platform/collections/vocab
Date: Sun, 03 Apr 1836 10:00:00 GMT-5
Cache-control: no-transform, max-age=604800
Transfer-encoding: chunked{
  "description" : "#SD-FSCV",
  "sourceDescriptions" : [ {
    "id" : "SD-FSCV",
    "about" : "#FSCV",
    "componentOf" : {
      "description" : "https://api.familysearch.org/platform/collection"
    },
    "resourceType" : "http://gedcomx.org/Collection",
    "titles" : [ {
      "value" : "FamilySearch Controlled Vocabulary"
    } ]
  } ],
  "collections" : [ {
    "id" : "FSCV",
    "title" : "FamilySearch Controlled Vocabulary",
    "links" : {
      "logout" : {
        "href" : "https://api.familysearch.org/platform/logout?flag=fsh"
      },
      "vocab-lists" : {
        "href" : "https://api.familysearch.org/platform/vocab/lists/111884?flag=fsh"
      },
      "http://oauth.net/core/2.0/endpoint/token" : {
        "href" : "https://api.familysearch.org/oauth2/v3/token?flag=fsh"
      },
      "self" : {
        "href" : "https://api.familysearch.org/platform/collections/vocab?flag=fsh"
      },
      "http://oauth.net/core/2.0/endpoint/authorize" : {
        "href" : "https://api.familysearch.org/oauth2/v3/authorization?flag=fsh"
      },
      "vocab-term" : {
        "template" : "https://api.familysearch.org/vocab/terms/{cvtid}?flag=fst"
      },
      "vocab-list" : {
        "template" : "https://api.familysearch.org/vocab/lists/{cvlid}?flag=fst"
      }
    }
  } ]
}

XML

Request

GET /platform/collections/vocab
Accept: application/x-gedcomx-v1+xml
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE

Response

HTTP/1.1 200 OK
Content-type: application/x-gedcomx-v1+xml
X-processing-time: 3
Vary: Accept,Accept-Language,Accept-Encoding,Expect
Content-location: /platform/collections/vocab
Date: Sun, 03 Apr 1836 10:00:00 GMT-5
Cache-control: no-transform, max-age=604800
Transfer-encoding: chunked<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<gedcomx xmlns:fs="http://familysearch.org/v1/" xmlns="http://gedcomx.org/v1/" xmlns:atom="http://www.w3.org/2005/Atom" description="#SD-FSCV">
    <sourceDescription about="#FSCV" resourceType="http://gedcomx.org/Collection" id="SD-FSCV">
        <componentOf description="https://api.familysearch.org/platform/collection"/>
        <title>FamilySearch Controlled Vocabulary</title>
    </sourceDescription>
    <collection id="FSCV">
        <link rel="vocab-lists" href="https://api.familysearch.org/platform/vocab/lists/111884?flag=fsh"/>
        <link rel="http://oauth.net/core/2.0/endpoint/authorize" href="https://api.familysearch.org/oauth2/v3/authorization?flag=fsh"/>
        <link rel="http://oauth.net/core/2.0/endpoint/token" href="https://api.familysearch.org/oauth2/v3/token?flag=fsh"/>
        <link rel="logout" href="https://api.familysearch.org/platform/logout?flag=fsh"/>
        <link rel="self" href="https://api.familysearch.org/platform/collections/vocab?flag=fsh"/>
        <link rel="vocab-list" template="https://api.familysearch.org/vocab/lists/{cvlid}?flag=fst"/>
        <link rel="vocab-term" template="https://api.familysearch.org/vocab/terms/{cvtid}?flag=fst"/>
        <title>FamilySearch Controlled Vocabulary</title>
    </collection>
</gedcomx>