Preferred Spouse Relationship
Path
/platform/tree/users/{uid}/preferred-spouse-relationships/{pid} |
|
| Production: | https://api.familysearch.org/platform/tree/users/{uid}/preferred-spouse-relationships/{pid} |
| Beta: | https://apibeta.familysearch.org/platform/tree/users/{uid}/preferred-spouse-relationships/{pid} |
| Integration (Integration): | https://api-integ.familysearch.org/platform/tree/users/{uid}/preferred-spouse-relationships/{pid} |
Description
The Preferred Spouse Relationship resource is used to read and to update the preferred spouse relationship of a tree person. The preferred spouse relationship affects only the user that creates it.
Operations
|
GET - Read the preferred spouse relationship for the given user and tree person. Produces - Specify a returned data format using the
Accept
header.
Parameters
Status Codes
|
||||||||||||
|
PUT - Set the preferred spouse relationship for the given user and tree person. Produces - Specify a returned data format using the
Accept
header.
Parameters
Status Codes
|
||||||||||||
|
DELETE - Delete the preferred spouse relationship for the given user and tree person. Produces - Specify a returned data format using the
Accept
header.
Parameters
Status Codes
|
Example Requests
| Delete Preferred Spouse Relationship | How to delete a user's preferred spouse relationship for a person. |
| Read Preferred Spouse Relationship | How to read a user's preferred spouse relationship for a person. |
| Update Preferred Spouse Relationship | How to set a user's preferred spouse relationship for a person. |