Person Not A Match List

Description

The Person Not A Match resource is the list of person(s) declared as not a match for a specified person.

Operations

GET - Get a list of not-a-match declarations associated with the person (as GedcomX); in other words, get a list of ids of other Persons who should not be merged with the indicated person, along with the associated reasons.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
pid path The id of the person.
Status Codes
  • 200  -  Upon a successful read.
  • 204  -  Upon a successful read and no not-a-match declarations exist.
  • 301  -  If the requested person no longer exists because it 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 not-a-match declaration.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
X-Reason header The header giving the reason for adding/removing a not-a-match declaration.
pid path The id of the person.
id query The non-match id(s) of the not-a-match declarations to be deleted, obtained from the Not A Match List resource. Required.
Status Codes
  • 204  -  The update was successful.
  • 404  -  If the requested person is not found.
  • 410  -  If the requested person has been merged or deleted.
  • 429  -  If the request was throttled.

POST - 

Add or edit a not-a-match declaration, indicating that the two referenced persons are separate and distinct individuals and should not be merged together. This operation will fail if there already exists a not-a-match declaration for the person(s).

A reason string can be provided indicating why the user believes the two persons to be distinct individuals. The reason is sent as an 'X-Reason' value in the HTTP Headers on the request. This reason can have a maximum length of 4000 characters, and if the reason supplied is more than 4000 characters, the request will fail as an invalid request.

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 header giving the reason for adding/removing a not-a-match declaration.
pid path The id of the person.
body request-body a GedcomX document with a list of persons
Status Codes
  • 204  -  The update was successful.
  • 404  -  If the requested person is not found.
  • 410  -  If the requested person has been merged or deleted.
  • 429  -  If the request was throttled.

Example Requests

Delete Person Not-a-Match Declarations How to delete person-not-a-match declarations for specific persons.
Read Person Not-A-Match Declarations How to read the persons that have been designated as not a match for a specific person.
Update Person Not-a-Match Declarations How to designate persons as not a match for a specific person.

Change Language

Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.