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.

The Couple Relationship for FamilySearch requires person1 to be male and person2 to be female.

Data Formats

If you make a GET request, specify the data format using the Accept header.

If you POST something, specify the media type using the Content-Type header.

Parameters

Name Type Description
X-Reason header Header giving the reason for updating or deleting the relationship.
Authorization header The authorization carrying the OAuth 2.0 access token. See OAuth 2.0 Bearer Tokens.
crid path The id of the couple relationship.
persons query When the query parameter is supplied then a person will be returned for each person in the relationship. The value of the parameter is not used.
access_token query The ID of the OAuth 2 access token used for identification and authorization of the user (and agent) making the request.

Operations

HEAD - Read the headers of the relationship.

Status Codes
200 Upon a successful read.
404 If the requested relationship is not found.
410 If the requested relationship has been deleted.
429 If the request was throttled.

GET - Read a relationship.

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.
429 If the request was throttled.

POST - Update a relationship.

Status Codes
204 The update was successful.
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.
429 If the request was throttled.

DELETE - Delete a relationship.

Status Codes
204 The delete was successful.
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.
429 If the request was throttled.

Example Requests

Create Couple Relationship How to create a couple resource.
Create Couple Relationship Source Reference How to create a source reference resource.
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.
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 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 Couple Relationship Notes How to get a list of notes on a couple relationship.
Read Non-Existent Couple Relationship Example illustrating a request for a couple that doesn't exist.
Head Couple Relationship How to get the couple resource headers.
Update Persons of a Couple Relationship How to update the persons that are associated by a couple relationship.
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.
Delete Couple Relationship How to delete a couple resource.
Delete Couple Relationship Conclusion How to delete a conclusion on a couple relationship.
Restore Couple Relationship How to un-delete or restore a couple relationship that has been deleted.