Child-and-Parents Relationship Note

Description

This Child-and-Parents Relationship Note resource defines the interface for a note attached to a child-and-parents relationship.

Operations

GET - Read a note.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
caprid path The ID of the relationship.
nid path The ID of the note.
Status Codes
  • 200  -  Upon a successful read.
  • 404  -  If the requested note is not found.
  • 429  -  If the request was throttled.

POST - Update a 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 Header giving the reason for changing or deleting a note.
caprid path The ID of the relationship.
nid path The ID of the note.
body request-body The note to be used for the update.
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 Header giving the reason for changing or deleting a note.
caprid path The ID of the relationship.
nid path The ID of the note.
Status Codes
  • 204  -  The delete was successful.
  • 404  -  If the requested note is not found.
  • 429  -  If the request was throttled.

Example Requests

Delete Child-and-Parents Relationship Note How to delete a note on a child-and-parents relationship.
Read Child-and-Parents Relationship Note How to read a note on a child-and-parents relationship.

Change Language

Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.