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.

Data Formats

Readable

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

Writable

If you POST something, specify the data format using the Content-Type header.

Parameters

Name Type Description
Authorization header The authorization carrying the OAuth 2.0 access token. See OAuth 2.0 Bearer Tokens.
X-Reason header Header giving the reason for changing or deleting a note.
nid path The id of the note.
pid path The id of the person.
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 a note.

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.
404 If the person is not found.
410 If the person has been deleted.
429 If the request was throttled.

POST - Update a note.

Status Codes
204 The update was successful.
301 If the person has been merged into another person.
404 If the requested note is not found.
404 If the person is not found.
410 If the person has been deleted.
429 If the request was throttled.

DELETE - Delete a note.

Status Codes
204 The delete was successful.
404 If the requested note is not found.
429 If the request was throttled.

Example Requests

Read Note How to read a note on a person.
Delete Note How to delete a note.
x

Select a language