Couple Relationship Note

Description

The Couple Relationship Note resource defines the interface for a note. It is to be considered an embedded resource, and any links to this resource are to be treated as embedded links.

Operations

GET - Read a tree couple relationship note.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
crid path The id of the tree couple relationship whose note is to be retrieved.
nid path The id of the note to be retrieved.
Status Codes
  • 200  -  Upon a successful read.
  • 404  -  If the requested note is not found.
  • 429  -  If the request was throttled.

POST - Update a 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 updating the note.
crid path The id of the tree couple relationship whose note is to be updated.
nid path The id of the note to be updated.
body request-body The note to be updated.
Status Codes
  • 204  -  The update was successful.
  • 404  -  If the requested note is not found.
  • 429  -  If the request was throttled.

DELETE - Delete a note.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
X-Reason header The reason for deleting the note.
crid path The id of the tree couple relationship whose note is to be updated.
nid path The id of the note to be deleted.
Status Codes
  • 204  -  The delete was successful.
  • 404  -  If the requested note is not found.
  • 429  -  If the request was throttled.

Example Requests

Delete Couple Relationship Note How to delete a note on a couple relationship.
Read Couple Relationship Note How to read a note on a couple relationship.
Update Couple Relationship Note How to update a note on a couple relationship.

Change Language

Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.