Update Illegal Couple Relationship

This example request illustrates what happens when you try to update a couple relationship to an illegal state. An illegal state occurs when the couple relationship is changed to any relationship deemed illegal by FamilySearch Family Tree.

JSON

Request

POST /platform/tree/couple-relationships/crid
Content-Type: application/x-gedcomx-v1+json
Accept: application/x-gedcomx-v1+json
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE
                
                  {
  "relationships" : [ {
    "id" : "crid",
    "type" : "http://gedcomx.org/Couple",
    "person1" : {
      "resource" : "https://api.familysearch.org/platform/tree/persons/FJP-M4RK",
      "resourceId" : "FJP-M4RK"
    },
    "person2" : {
      "resource" : "https://api.familysearch.org/platform/tree/persons/JRW-NMSD",
      "resourceId" : "JRW-NMSD"
    },
    "facts" : [ {
      "attribution" : {
        "contributor" : {
          "resource" : "https://api.familysearch.org/platform/users/agents/JNYR-KJP"
        },
        "changeMessage" : "...change message..."
      },
      "type" : "http://gedcomx.org/Marriage",
      "date" : {
        "original" : "June 1800",
        "formal" : "+1800-06"
      },
      "place" : {
        "original" : "Provo, Utah, Utah, United States"
      }
    } ]
  } ]
}
                
              

Response

HTTP/1.1 400 Bad Request
Content-type: application/x-gedcomx-v1+json
X-processing-time: 3
Vary: Accept,Accept-Language,Accept-Encoding,Expect
Content-location: /platform/tree/couple-relationships/crid
Date: Sun, 03 Apr 1836 10:00:00 GMT-5
Cache-control: no-cache, no-store, no-transform, must-revalidate, max-age=0
Transfer-encoding: chunked
                
                  {
  "errors" : [ {
    "code" : 400
  } ]
}
                
              

XML

Request

POST /platform/tree/couple-relationships/crid
Content-Type: application/x-gedcomx-v1+xml
Accept: application/x-gedcomx-v1+xml
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE
                
                  <?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">
    <relationship type="http://gedcomx.org/Couple" id="crid">
        <person1 resource="https://api.familysearch.org/platform/tree/persons/FJP-M4RK" resourceId="FJP-M4RK"/>
        <person2 resource="https://api.familysearch.org/platform/tree/persons/JRW-NMSD" resourceId="JRW-NMSD"/>
        <fact type="http://gedcomx.org/Marriage">
            <attribution>
                <contributor resource="https://api.familysearch.org/platform/users/agents/JNYR-KJP"/>
                <changeMessage>...change message...</changeMessage>
            </attribution>
            <date>
                <original>June 1800</original>
                <formal>+1800-06</formal>
            </date>
            <place>
                <original>Provo, Utah, Utah, United States</original>
            </place>
        </fact>
    </relationship>
</gedcomx>

                
              

Response

HTTP/1.1 400 Bad Request
Content-type: application/x-gedcomx-v1+xml
X-processing-time: 3
Vary: Accept,Accept-Language,Accept-Encoding,Expect
Content-location: /platform/tree/couple-relationships/crid
Date: Sun, 03 Apr 1836 10:00:00 GMT-5
Cache-control: no-cache, no-store, no-transform, must-revalidate, max-age=0
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">
    <fs:error>
        <fs:code>400</fs:code>
    </fs:error>
</gedcomx>