Person

Description

The Person resource provides the interface to read, update, or delete a person, including the names, gender, or facts of the person.

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 updating or deleting a person.
Authorization header The authorization carrying the OAuth 2.0 access token. See OAuth 2.0 Bearer Tokens.
pid path The id of the person.
skipDateNormalization query When the parameter is true, then normalized dates remain blank even when the original value is filled in. (By default the original will be normalized automatically if the normalized value is blank).
relatives query Specifies that related persons should be included in the response.
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

HEAD - Read the headers of a person.

Status Codes
200 Upon a successful read.
301 If the requested person has been merged to another person.
404 If the requested person is not found.
410 If the requested person has been deleted.
429 If the request was throttled.

GET - Read a person.

Status Codes
200 Upon a successful read.
301 If the requested person has been merged into another person.
404 If the requested person is not found.
410 If the requested person has been deleted.
429 If the request was throttled.

POST - Update a person.

Status Codes
201 The successful update contained a single conclusion. Expect the id of the conclusion in the 'Location' header.
204 The update was successful.
301 If the requested person has been merged into another person.
404 If the requested person is not found.
410 If the requested person has been deleted.
429 If the request was throttled.

DELETE - Delete a person.

Status Codes
204 The delete was successful.
301 If the requested person has been merged into another person.
403 If you're trying to delete a person that other users have contributed to.
404 If the requested person is not found.
409 If an attempt was made to delete the person while another request committed a change to the person.
410 If the requested person has already been deleted.
429 If the request was throttled.

Example Requests

Create Person How to create a person.
Create Person Source Reference How to create a source reference on a person.
Create Person Conclusion How to create a conclusion.
Create Person Life Sketch How to create a life sketch for a person.
Create Discussion Reference How to attach a discussion to a person.
Create Note How to create a note on a person.
Read Merged Person Example illustrating what happens during a read of a person that has been merged.
Read Deleted Person Example illustrating what happens during a read of person that has been deleted.
Read Person How to read a person.
Read Person Sources How to query for the list of sources on a person.
Read Relationships To Spouses (Deprecated) How to read the list of relationships to the spouses of a person.
Read Children of a Person How to read the list of children of a person.
Read Not Found Person Example illustrating what happens during a read of a person that doesn't exist.
Read Not Modified Person How to conditionally read a person that hasn't been modified.
Read Notes How to read the list of notes on a person.
Read Parents of a Person How to read the list of parents of a person, including any couple relationships of the parents.
Read Spouses of a Person How to read the spouses of a person.
Head Person How to read the headers for a person.
Update Person Source Reference How to update a source reference on a person.
Update Person Conclusion How to update a conclusion resource.
Update Person Custom Non-Event Fact How to update a custom fact that is designated as "not an event" in the Family Tree.
Update Person Life Sketch How to create a life sketch for a person.
Update Person With Preconditions How to do a conditional update of a person.
Delete Person How to delete a person.
Delete Person Source Reference How to delete a source reference.
Delete Person Conclusion How to delete a conclusion resource.
Delete Person With Preconditions How to do a conditional delete of a person.
Delete Discussion Reference How to delete a discussion resource.
Restore Person How to un-delete or restore a person resource that has been deleted.