Read User-Defined Sources Collection

This example request illustrates how to read the FamilySearch User-Defined Sources Collection. The FamilySearch User-Defined Sources Collection resource contains all user-defined sources.

JSON

Request

GET /platform/collections/sources
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/sources
Date: Sun, 03 Apr 1836 10:00:00 GMT-5
Cache-control: no-transform, max-age=604800
Transfer-encoding: chunked{
  "links" : {
    "source-description-template" : {
      "template" : "https://api.familysearch.org/sources/descriptions/{sdid}?flag=fst"
    },
    "agent-template" : {
      "template" : "https://api.familysearch.org/users/agents/{uid}?flag=fst"
    }
  },
  "description" : "#SD-FSUDS",
  "sourceDescriptions" : [ {
    "id" : "SD-FSUDS",
    "about" : "#FSUDS",
    "componentOf" : {
      "description" : "https://api.familysearch.org/platform/collection"
    },
    "resourceType" : "http://gedcomx.org/Collection",
    "titles" : [ {
      "value" : "FamilySearch User-Defined Sources"
    } ]
  } ],
  "collections" : [ {
    "id" : "FSUDS",
    "title" : "FamilySearch User-Defined Sources",
    "links" : {
      "subcollections" : {
        "href" : "https://api.familysearch.org/sources/collections?flag=fsh"
      },
      "logout" : {
        "href" : "https://api.familysearch.org/platform/logout?flag=fsh"
      },
      "source-descriptions" : {
        "href" : "https://api.familysearch.org/sources/descriptions?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/sources?flag=fsh"
      },
      "collection" : {
        "href" : "https://api.familysearch.org/platform/collection?flag=fsh"
      },
      "http://oauth.net/core/2.0/endpoint/authorize" : {
        "href" : "https://api.familysearch.org/oauth2/v3/authorization?flag=fsh"
      }
    }
  } ]
}

XML

Request

GET /platform/collections/sources
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/sources
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-FSUDS">
    <link rel="agent-template" template="https://api.familysearch.org/users/agents/{uid}?flag=fst"/>
    <link rel="source-description-template" template="https://api.familysearch.org/sources/descriptions/{sdid}?flag=fst"/>
    <sourceDescription about="#FSUDS" resourceType="http://gedcomx.org/Collection" id="SD-FSUDS">
        <componentOf description="https://api.familysearch.org/platform/collection"/>
        <title>FamilySearch User-Defined Sources</title>
    </sourceDescription>
    <collection id="FSUDS">
        <link rel="collection" href="https://api.familysearch.org/platform/collection?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/sources?flag=fsh"/>
        <link rel="source-descriptions" href="https://api.familysearch.org/sources/descriptions?flag=fsh"/>
        <link rel="subcollections" href="https://api.familysearch.org/sources/collections?flag=fsh"/>
        <title>FamilySearch User-Defined Sources</title>
    </collection>
</gedcomx>