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.

Operations

GET - Read the list of notes associated with a tree couple relationship.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
crid path The id of the tree couple relationship whose notes are to be retrieved.
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 tree couple relationship note.

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 The reason for creating the note.
crid path The id of the couple relationship the note is for.
body request-body The note to be created.
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 Notes How to update a note on a couple relationship.

Change Language

Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.