Genealogies Relationship

Prototype: This resource is currently in a prototype development state. It may or may not be operational and the interface may change prior to release. Feedback is welcome.

Description

The Relationship resource manages a specific relationship and provides the interface to update, and delete a relationship. The Relationship also provides the interface to add or update specific facts attached to a relationship.

Coupler relationships for FamilySearch Genealogies require person1 to be male and person2 to be female.

Operations

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 Header giving the reason for updating the relationship.
cid path The id of the relationship.
pid path The id of the person.
body request-body The relationship to be used for the update.
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.
  • 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.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
X-Reason header Header giving the reason for deleting the relationship.
cid path The id of the relationship.
pid path The id of the person.
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.
  • 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 Genealogies Relationship Conclusion How to create a relationship conclusion.
Delete Genealogies Relationship How to delete a relationship resource.

Change Language

Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.