Read Couple Relationship Change History

This example request illustrates how to read the change history for a couple relationship. Each entry in the change history response provides details about what was changed, who performed the change, and an explanation of why the change was made if the reason was provided by the user.

JSON

Request

GET /platform/tree/couple-relationships/P12-345/changes
Accept: application/x-gedcomx-atom+json
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE
                
              

Response

HTTP/1.1 200 OK
Content-type: application/x-gedcomx-atom+json
X-processing-time: 3
Vary: Accept,Accept-Language,Accept-Encoding,Expect
Date: Sun, 03 Apr 1836 10:00:00 GMT-5
Cache-control: no-transform, must-revalidate, max-age=0
Transfer-encoding: chunked
                
                  {
  "id" : "uuid:random_uuid",
  "title" : "Change History for Couple Relationship P12-345",
  "updated" : 1543677067759,
  "links" : {
    "self" : {
      "href" : "https://api.familysearch.org/platform/tree/couple-relationships/P12-345/changes?flag=fsh"
    },
    "relationship" : {
      "href" : "https://api.familysearch.org/platform/tree/couple-relationships/P12-345?flag=fsh"
    }
  },
  "entries" : [ {
    "id" : "123Pid",
    "title" : "Couple Relationship Created",
    "updated" : 1543677067759,
    "contributors" : [ {
      "name" : "Mr. Contributor"
    } ],
    "links" : {
      "agent" : {
        "href" : "https://api.familysearch.org/users/agents/UKMGTY?flag=fsh"
      },
      "restore" : {
        "href" : "https://api.familysearch.org/platform/tree/changes/chid/restore?flag=fsh"
      }
    },
    "changeInfo" : [ {
      "operation" : "http://familysearch.org/v1/Create",
      "objectType" : "http://gedcomx.org/Couple",
      "reason" : "because it was necessary"
    } ]
  }, {
    "id" : "123Pid",
    "title" : "Couple Event Added",
    "updated" : 1543677067759,
    "contributors" : [ {
      "name" : "Mr. Contributor"
    } ],
    "links" : {
      "agent" : {
        "href" : "https://api.familysearch.org/users/agents/UKMGTY?flag=fsh"
      },
      "restore" : {
        "href" : "https://api.familysearch.org/platform/tree/changes/chid/restore?flag=fsh"
      }
    },
    "changeInfo" : [ {
      "operation" : "http://familysearch.org/v1/Create",
      "objectType" : "http://gedcomx.org/Fact",
      "objectModifier" : "http://gedcomx.org/Couple",
      "reason" : "because it was necessary"
    } ]
  }, {
    "id" : "123Pid",
    "title" : "Couple Relationship Removed",
    "updated" : 1543677067759,
    "contributors" : [ {
      "name" : "Mr. Contributor"
    } ],
    "links" : {
      "agent" : {
        "href" : "https://api.familysearch.org/users/agents/UKMGTY?flag=fsh"
      },
      "restore" : {
        "href" : "https://api.familysearch.org/platform/tree/changes/chid/restore?flag=fsh"
      }
    },
    "changeInfo" : [ {
      "operation" : "http://familysearch.org/v1/Delete",
      "objectType" : "http://gedcomx.org/Couple",
      "reason" : "because it was necessary"
    } ]
  } ]
}
                
              

XML

Request

GET /platform/tree/couple-relationships/P12-345/changes
Accept: application/atom+xml
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE
                
              

Response

HTTP/1.1 200 OK
Content-type: application/atom+xml
X-processing-time: 3
Vary: Accept,Accept-Language,Accept-Encoding,Expect
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"?>
<feed xmlns:fs="http://familysearch.org/v1/" xmlns:gx="http://gedcomx.org/v1/" xmlns="http://www.w3.org/2005/Atom">
    <id>uuid:random_uuid</id>
    <link rel="relationship" href="https://api.familysearch.org/platform/tree/couple-relationships/P12-345?flag=fsh"/>
    <link rel="self" href="https://api.familysearch.org/platform/tree/couple-relationships/P12-345/changes?flag=fsh"/>
    <title>Change History for Couple Relationship P12-345</title>
    <updated>2018-12-01T08:11:07.759-07:00</updated>
    <entry>
        <fs:changeInfo objectType="http://gedcomx.org/Couple" operation="http://familysearch.org/v1/Create" reason="because it was necessary"/>
        <contributor>
            <name>Mr. Contributor</name>
        </contributor>
        <id>123Pid</id>
        <link rel="agent" href="https://api.familysearch.org/users/agents/UKMGTY?flag=fsh"/>
        <link rel="restore" href="https://api.familysearch.org/platform/tree/changes/chid/restore?flag=fsh"/>
        <title>Couple Relationship Created</title>
        <updated>2018-12-01T08:11:07.759-07:00</updated>
    </entry>
    <entry>
        <fs:changeInfo objectModifier="http://gedcomx.org/Couple" objectType="http://gedcomx.org/Fact" operation="http://familysearch.org/v1/Create" reason="because it was necessary"/>
        <contributor>
            <name>Mr. Contributor</name>
        </contributor>
        <id>123Pid</id>
        <link rel="agent" href="https://api.familysearch.org/users/agents/UKMGTY?flag=fsh"/>
        <link rel="restore" href="https://api.familysearch.org/platform/tree/changes/chid/restore?flag=fsh"/>
        <title>Couple Event Added</title>
        <updated>2018-12-01T08:11:07.759-07:00</updated>
    </entry>
    <entry>
        <fs:changeInfo objectType="http://gedcomx.org/Couple" operation="http://familysearch.org/v1/Delete" reason="because it was necessary"/>
        <contributor>
            <name>Mr. Contributor</name>
        </contributor>
        <id>123Pid</id>
        <link rel="agent" href="https://api.familysearch.org/users/agents/UKMGTY?flag=fsh"/>
        <link rel="restore" href="https://api.familysearch.org/platform/tree/changes/chid/restore?flag=fsh"/>
        <title>Couple Relationship Removed</title>
        <updated>2018-12-01T08:11:07.759-07:00</updated>
    </entry>
</feed>