Child-and-Parents Relationship Notes

Description

This Child-and-Parents Relationship Notes resource defines the list of notes attached to a child-and-parents relationship.

Operations

GET - Read the list of notes on the relationship.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
caprid path The ID of the child-and-parents relationship.
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 - Attach 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 creating a note.
caprid path The ID of the child-and-parents relationship.
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 Child-and-Parents Relationship Note How to create a note on a child-and-parents relationship.
Read Child-and-Parents Relationship Notes How to get a list of notes on a child-and-parents relationship.
Update Child-and-Parents Relationship Note How to update a note on a child-and-parents relationship.

Change Language

Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.