Couple Relationship

Description

The Couple Relationship resource manages a specific couple relationship and provides the interface to read, update, and delete a couple relationship. The Couple Relationship also provides the interface to add or update specific facts attached to a couple. FamilySearch also allows you to update the persons in a couple relationship.

Operations

GET - Read a relationship.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
crid path The id of the couple relationship.
persons query 'true' if a person is to be returned for each person in the relationship; false otherwise.
Status Codes
  • 200  -  Upon a successful read.
  • 301  -  If the requested relationship has been merged to another relationship.
  • 404  -  If the requested relationship is not found.
  • 410  -  If the requested relationship has been deleted or merged.
  • 429  -  If the request was throttled.

POST - Update a relationship.

Produces - Specify a returned data format using the Accept header.
Consumes - Specify the incoming data format using the Content-Type header.
Parameters
Name Type Description
X-Reason header The reason for the couple relationship update.
crid path The id of the couple relationship.
body request-body The couple relationship to be updated.
Status Codes
  • 201  -  The successful update contained a single conclusion. Expect the id of the conclusion in the 'Location' header.
  • 204  -  The update was successful.
  • 404  -  If the requested relationship is not found.
  • 410  -  If the requested relationship has been deleted or merged.
  • 429  -  If the request was throttled.

DELETE - Delete a relationship.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
X-Reason header The reason for the couple relationship update.
crid path The id of the couple relationship.
Status Codes
  • 204  -  The delete was successful.
  • 404  -  If the requested relationship is not found.
  • 409  -  If an attempt was made to delete the relationship while another request committed a change to the relationship.
  • 410  -  If the requested relationship has been deleted.
  • 429  -  If the request was throttled.

Example Requests

Create Couple Relationship How to create a couple relationship.
Create Couple Relationship Conclusion How to add a conclusion to a couple relationship.
Create Couple Relationship Note How to create a note on a relationship.
Create Couple Relationship Source Reference How to create a source reference resource.
Delete Couple Relationship How to delete a couple resource.
Delete Couple Relationship Conclusion How to delete a conclusion on a couple relationship.
Head Couple Relationship How to get the couple resource headers.
Read Couple Relationship How to get a couple resource.
Read Couple Relationship (Conditional) Example illustrating how the caching mechanism works on the couple using the Etag header.
Read Couple Relationship Notes How to get a list of notes on a couple relationship.
Read Couple Relationship Source References How to get a list of source reference resources.
Read Couple Relationship Sources How to query for the list of sources on a couple relationship.
Read Non-Existent Couple Relationship Example illustrating a request for a couple that doesn't exist.
Restore Couple Relationship How to un-delete or restore a couple relationship that has been deleted.
Update Couple Relationship Conclusion How to update a conclusion on a couple relationship.
Update Illegal Couple Relationship Update the persons that are associated by a couple relationship, triggering the gender constraint.
Update Persons of a Couple Relationship How to update the persons that are associated by a couple relationship.
Change Language
Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.