Attention: This site does not support the current version of your web browser. To get the best possible experience using our website we recommend that you upgrade to a newer version or install another browser

Couple Relationship Notes

Description

The Couple Relationship Notes resource defines the interface for a list of notes attached to an entity (e.g., person, relationship). It is to be considered an embedded resource, and any links to this resource are to be treated as embedded links.

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.
X-Reason header Header giving the reason for creating a note.
crid path The id of the couple relationship.
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

GET - Read the list of notes on the entity.

Status Codes
200 Upon a successful read.
204 Upon a successful query with no results.
404 The specified entity has been moved, deleted, or otherwise not found.
429 If the request was throttled.

POST - Create a note.

Status Codes
201 The creation of the note was successful. Expect a location header specifying the link to the note.
400 If the request was unable to be understood by the application.
429 If the request was throttled.

Example Requests

Create Couple Relationship Note How to create a note on a relationship.
Read Couple Relationship Notes How to get a list of notes on a couple relationship.
Update Couple Relationship Note How to update a note on a couple relationship.
x

Select a language