Person Relationships to Spouses

Description

The Person Relationships to Spouses resource provides the interface for the list of relationships between a person and that person's spouses.

As of June 27, 2016 this resource is deprecated because relationships are automatically included in the Person resource. Starting December 6, 2016, the consolidate-redundant-resources pending modification will be activated and this resource will redirect to the Person resource.

Data Formats

Readable

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

Writable

If you POST something, specify the data format using the Content-Type header.

Parameters

Name Type Description
Authorization header The authorization carrying the OAuth 2.0 access token. See OAuth 2.0 Bearer Tokens.
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.
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.

Operations

GET - Read the set of spouse relationships for a specific person.

Status Codes
200 Upon a successful read.
204 Upon a successful read and no relationships exist.
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.

Example Requests

Read Relationships To Spouses (Deprecated) How to read the list of relationships to the spouses of a person.
Read Relationships to Spouses (Starting December 2016) An example of an attempt to read spouse relationships after the "consolidate-redundant-resources" modification is activated in December 2016.
x

Select a language