Preferred Spouse Relationship

Description

The Preferred Spouse Relationship resource is used to read and to update the preferred spouse relationship of a person. The preferred spouse relationship affects only the user that creates it.

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
Location header URI for the preferred spouse relationship
Authorization header The authorization carrying the OAuth 2.0 access token. See OAuth 2.0 Bearer Tokens.
uid path The id of the user.
pid path The id of the person.
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 preferred relationships headers.

Status Codes
204 No preference specified.
301 If the person has been merged into another person.
303 Upon a successful read.
404 If the person is not found.
410 If the person has been deleted.
429 If the request was throttled.

GET - Read a reference to a preferred relationship.

Status Codes
204 No preference specified.
301 If the person has been merged into another person.
303 Upon a successful read.
404 If the person is not found.
410 If the person has been deleted.
429 If the request was throttled.

PUT - Set a reference to a preferred relationship.

Status Codes
204 The update was successful.
301 If the person has been merged into another person.
404 If the person is not found.
410 If the person has been deleted.
429 If the request was throttled.

DELETE - Delete a reference to a preferred relationship.

Status Codes
204 The delete was successful.
404 If the requested preferred parent relationship reference is not found.
429 If the request was throttled.

Example Requests

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.
Delete Preferred Spouse Relationship How to delete a user's preferred spouse relationship for a person.