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. This means that some implementations MAY choose to bind this interface to the containing resource (person or 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
Authorization header The authorization carrying the OAuth 2.0 access token. See OAuth 2.0 Bearer Tokens.
X-FS-Feature-Tag header The comma-separated list of features to enable for the request. This list is used to enable any specific Pending Modifications. For more information, see the API Evolution Guide
X-Reason header Header giving the reason for creating a 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 the list of notes on the entity.

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 If the person is not found.
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.

Status Codes
201 The creation of the note was successful. Expect a location header specifying the link to the note.
301 If the person has been merged into another person.
400 If the request was unable to be understood by the application.
404 If the person is not found.
410 If the person has been 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.