Read Source Folder

This example request illustrates how to read a source folder.

JSON

Request

GET /platform/sources/collections/sf-MMMM-MMM
Accept: application/x-fs-v1+json
Content-Type: application/x-fs-v1+json
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE

Response

HTTP/1.1 200 OK
Content-type: application/x-fs-v1+json
X-entity-id: sf-MMMM-MMM
X-processing-time: 3
Vary: Accept,Accept-Language,Accept-Encoding,Expect
Content-location: /platform/sources/collections/sf-MMMM-MMM
Date: Sun, 03 Apr 1836 10:00:00 GMT-5
Cache-control: no-transform, must-revalidate, max-age=0
Transfer-encoding: chunked{
  "sourceDescriptions" : [ {
    "attribution" : {
      "contributor" : {
        "resource" : "https://familysearch.org/platform/users/agents/123"
      },
      "modified" : 1543677067759,
      "changeMessage" : "This is the change message"
    },
    "titles" : [ {
      "value" : "Name"
    } ]
  } ],
  "collections" : [ {
    "id" : "sf-MMMM-MMM",
    "title" : "Name",
    "attribution" : {
      "contributor" : {
        "resource" : "https://familysearch.org/platform/users/agents/123"
      },
      "modified" : 1543677067759,
      "changeMessage" : "This is the change message"
    },
    "links" : {
      "source-descriptions" : {
        "href" : "https://api.familysearch.org/platform/sources/collections/sf-MMMM-MMM/descriptions?flag=fsh"
      },
      "self" : {
        "href" : "https://api.familysearch.org/platform/sources/collections/sf-MMMM-MMM?flag=fsh"
      },
      "collection" : {
        "href" : "https://api.familysearch.org/platform/sources/collections?flag=fsh"
      }
    }
  } ]
}

XML

Request

GET /platform/sources/collections/sf-MMMM-MMM
Accept: application/x-fs-v1+xml
Content-Type: application/x-fs-v1+xml
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE

Response

HTTP/1.1 200 OK
Content-type: application/x-fs-v1+xml
X-entity-id: sf-MMMM-MMM
X-processing-time: 3
Vary: Accept,Accept-Language,Accept-Encoding,Expect
Content-location: /platform/sources/collections/sf-MMMM-MMM
Date: Sun, 03 Apr 1836 10:00:00 GMT-5
Cache-control: no-transform, must-revalidate, max-age=0
Transfer-encoding: chunked<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<fs:familysearch xmlns:fs="http://familysearch.org/v1/" xmlns="http://gedcomx.org/v1/" xmlns:atom="http://www.w3.org/2005/Atom">
    <sourceDescription>
        <title>Name</title>
        <attribution>
            <contributor resource="https://familysearch.org/platform/users/agents/123"/>
            <modified>2018-12-01T08:11:07.759-07:00</modified>
            <changeMessage>This is the change message</changeMessage>
        </attribution>
    </sourceDescription>
    <collection id="sf-MMMM-MMM">
        <link rel="collection" href="https://api.familysearch.org/platform/sources/collections?flag=fsh"/>
        <link rel="self" href="https://api.familysearch.org/platform/sources/collections/sf-MMMM-MMM?flag=fsh"/>
        <link rel="source-descriptions" href="https://api.familysearch.org/platform/sources/collections/sf-MMMM-MMM/descriptions?flag=fsh"/>
        <title>Name</title>
        <attribution>
            <contributor resource="https://familysearch.org/platform/users/agents/123"/>
            <modified>2018-12-01T08:11:07.759-07:00</modified>
            <changeMessage>This is the change message</changeMessage>
        </attribution>
    </collection>
</fs:familysearch>