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.

Data Formats

If you make a GET request, specify the data format using the Accept header.

If you POST something, specify the media type using the Content-Type header.

Parameters

Name Type Description
X-Reason header Header giving the reason for creating a note.
Authorization header The authorization carrying the OAuth 2.0 access token. See OAuth 2.0 Bearer Tokens.
caprid path The ID of the child-and-parents 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 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.

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.