Person

Description

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

Operations

GET - Read a person.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
pid path The id of the person to retrieve.
failOnError query True if call is to fail on sources read error; false otherwise (will return person without failed sources). Default=false.
relatives query True if related persons (all parents, all children, all spouses, and all siblings) should be included in the response; false otherwise.
sourceDescriptions query True if the call will attempt to include source descriptions; false otherwise.
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.

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 reason for the person update.
pid path The id of the person to update.
body request-body The person to be updated.
Status Codes
  • 200  -  The return.conclusion.ids Pending Modification is enabled. Expect conclusion ids to be returned in the response body.
  • 201  -  The update created a single conclusion. The new conclusion URL is in the 'Location' header.
  • 204  -  The update was successful.
  • 404  -  If the requested person is not found.
  • 410  -  If the requested person has been deleted or merged.
  • 429  -  If the request was throttled.

DELETE - Delete a person.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
X-Reason header The reason the person is to be deleted.
pid path The id of the person to delete.
Status Codes
  • 204  -  The delete was successful.
  • 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 merged or deleted.
  • 429  -  If the request was throttled.

Example Requests

Create Discussion Reference How to attach a discussion to a person.
Create Note How to create a note on a person.
Create Person How to create a person.
Create Person Conclusion How to create a conclusion.
Create Person Life Sketch How to create a life sketch for a person.
Create Person Source Reference How to create a source reference on a person.
Delete Discussion Reference How to delete a discussion resource.
Delete Person How to delete a person.
Delete Person Conclusion How to delete a conclusion resource.
Delete Person Source Reference How to delete a source reference.
Delete Person With Preconditions How to do a conditional delete of a person.
Head Person How to read the headers for a person.
Read Children of a Person How to read the list of children of a person.
Read Deleted Person Example illustrating what happens during a read of person that has been deleted.
Read Merged Person Example illustrating what happens during a read of a person that has been merged.
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 Person How to read a person.
Read Person Sources How to query for the list of sources on a person.
Read Spouses of a Person How to read the spouses of a person.
Read Spouses of a Person but no Relationship How to read the spouses of a person but no Relationship is returned.
Restore Person How to un-delete or restore a person resource that has been deleted.
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 Source Reference How to update a source reference on a person.
Update Person With Preconditions How to do a conditional update of a person.

Change Language

Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.