Person Note

Description

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

Operations

GET - Read a note.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
nid path The id of the note to be retrieved.
pid path The id of the person whose note is to be retrieved.
Status Codes
  • 200  -  Upon a successful read.
  • 301  -  If the person has been merged into another person.
  • 404  -  If the requested note is not found.
  • 410  -  If the person has been deleted.
  • 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 The optional reason for updating the note.
nid path The id of the note to be updated.
pid path The id of the person whose note is to be updated.
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.
  • 410  -  If the person has been merged or deleted.
  • 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 optional reason for deleting the note.
nid path The id of the note to be deleted.
pid path The id of the person whose note is 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 Note How to delete a note.
Read Note How to read a note on a person.

Change Language

Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.