Person Notes

Description

The Person Notes resource defines the interface for a list of notes attached to an entity (e.g., person, relationship). The Person Notes resource 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.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
pid path The id of the person whose notes are to be retrieved.
Status Codes
  • 200  -  Upon a successful read.
  • 204  -  Upon a successful query with no results.
  • 301  -  If the person has been merged into another person.
  • 404  -  The specified entity has been moved, deleted, or otherwise not found.
  • 410  -  If the person has been deleted.
  • 429  -  If the request was throttled.

POST - Create 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 The optional reason for creating the note.
pid path The id of the person for whom the note is to be created.
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.
  • 404  -  If the request was throttled.
  • 410  -  If the person has been merged or deleted.
  • 429  -  If the request was throttled.

Example Requests

Create Note How to create a note on a person.
Read Notes How to read the list of notes on a person.
Update Note How to update a note.

Change Language

Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.