Read Matches by Tree Person Id for All Match Status Types

This example request illustrates how to read the record matches for a tree person id for types of match statuses (i.e., accepted, pending, rejected). By default, only matches with a type status of accepted are shown.

JSON

Request

GET /platform/tree/persons/GRN-MN/matches?status=pending&status=accepted&status=rejected&collection=https://familysearch.org/platform/collections/records
Accept: application/x-gedcomx-atom+json
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE

Response

HTTP/1.1 200 OK
Content-type: application/x-gedcomx-atom+json
X-processing-time: 3
Vary: Accept,Accept-Language,Accept-Encoding,Expect
Date: Sun, 03 Apr 1836 10:00:00 GMT-5
Cache-control: no-cache, no-store, no-transform, must-revalidate, max-age=0
Transfer-encoding: chunked{
  "id" : "uuid:random_uuid",
  "results" : 3,
  "index" : 1,
  "title" : "Record Match Results",
  "updated" : 1543677067759,
  "links" : {
    "person" : {
      "href" : "https://api.familysearch.org/platform/tree/persons/GRN-MN?flag=fsh"
    },
    "self" : {
      "href" : "https://api.familysearch.org/platform/tree/persons/GRN-MN/matches?flag=fsh&collection=https://familysearch.org/platform/collections/records&status=pending"
    },
    "collection" : {
      "href" : "https://api.familysearch.org/collections/tree?flag=fsh"
    }
  },
  "entries" : [ {
    "content" : {
      "gedcomx" : {
        "sourceDescriptions" : [ {
          "resourceType" : "http://gedcomx.org/Collection",
          "titles" : [ {
            "value" : "FamilySearch Historical Collection 173"
          } ],
          "identifiers" : {
            "http://gedcomx.org/Persistent" : [ "https://familysearch.org/platform/records/collections/173" ]
          }
        } ]
      }
    },
    "id" : "https://familysearch.org/ark:/61903/1:1:MMMM-7P1",
    "score" : 0.9824,
    "confidence" : 4,
    "title" : "FamilySearch Historical Collection 173",
    "updated" : 1543677067759,
    "links" : {
      "person" : {
        "href" : "https://api.familysearch.org/platform/tree/persons/GRN-MN?flag=fsh"
      }
    },
    "matchInfo" : [ {
      "collection" : "https://familysearch.org/platform/collections/records",
      "status" : "http://familysearch.org/v1/Accepted"
    } ]
  }, {
    "content" : {
      "gedcomx" : {
        "sourceDescriptions" : [ {
          "resourceType" : "http://gedcomx.org/Collection",
          "titles" : [ {
            "value" : "FamilySearch Historical Collection 268"
          } ],
          "identifiers" : {
            "http://gedcomx.org/Persistent" : [ "https://familysearch.org/platform/records/collections/268" ]
          }
        } ]
      }
    },
    "id" : "https://familysearch.org/ark:/61903/1:1:MMMM-8NN",
    "score" : 0.01572,
    "confidence" : 3,
    "title" : "FamilySearch Historical Collection 268",
    "updated" : 1543677067759,
    "links" : {
      "person" : {
        "href" : "https://api.familysearch.org/platform/tree/persons/GRN-MN?flag=fsh"
      }
    },
    "matchInfo" : [ {
      "collection" : "https://familysearch.org/platform/collections/records",
      "status" : "http://familysearch.org/v1/Rejected"
    } ]
  }, {
    "content" : {
      "gedcomx" : {
        "sourceDescriptions" : [ {
          "resourceType" : "http://gedcomx.org/Collection",
          "titles" : [ {
            "value" : "FamilySearch Historical Collection 363"
          } ],
          "identifiers" : {
            "http://gedcomx.org/Persistent" : [ "https://familysearch.org/platform/records/collections/363" ]
          }
        } ]
      }
    },
    "id" : "https://familysearch.org/ark:/61903/1:1:MMMM-JC3",
    "score" : 1.8981,
    "confidence" : 5,
    "title" : "FamilySearch Historical Collection 363",
    "updated" : 1543677067759,
    "links" : {
      "person" : {
        "href" : "https://api.familysearch.org/platform/tree/persons/GRN-MN?flag=fsh"
      }
    },
    "matchInfo" : [ {
      "collection" : "https://familysearch.org/platform/collections/records",
      "status" : "http://familysearch.org/v1/Pending"
    } ]
  } ]
}

XML

Request

GET /platform/tree/persons/GRN-MN/matches?status=pending&status=accepted&status=rejected&collection=https://familysearch.org/platform/collections/records
Accept: application/atom+xml
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE

Response

HTTP/1.1 200 OK
Content-type: application/atom+xml
X-processing-time: 3
Vary: Accept,Accept-Language,Accept-Encoding,Expect
Date: Sun, 03 Apr 1836 10:00:00 GMT-5
Cache-control: no-cache, no-store, no-transform, must-revalidate, max-age=0
Transfer-encoding: chunked<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<feed xmlns:fs="http://familysearch.org/v1/" xmlns:gx="http://gedcomx.org/v1/" xmlns="http://www.w3.org/2005/Atom">
    <id>uuid:random_uuid</id>
    <gx:results>3</gx:results>
    <gx:index>1</gx:index>
    <link rel="collection" href="https://api.familysearch.org/collections/tree?flag=fsh"/>
    <link rel="person" href="https://api.familysearch.org/platform/tree/persons/GRN-MN?flag=fsh"/>
    <link rel="self" href="https://api.familysearch.org/platform/tree/persons/GRN-MN/matches?flag=fsh&amp;collection=https://familysearch.org/platform/collections/records&amp;status=pending"/>
    <title>Record Match Results</title>
    <updated>2018-12-01T08:11:07.759-07:00</updated>
    <entry>
        <fs:matchInfo collection="https://familysearch.org/platform/collections/records" status="http://familysearch.org/v1/Accepted"/>
        <gx:confidence>4</gx:confidence>
        <content type="application/x-gedcomx-v1+xml">
            <gx:gedcomx>
                <gx:sourceDescription resourceType="http://gedcomx.org/Collection">
                    <gx:title>FamilySearch Historical Collection 173</gx:title>
                    <gx:identifier type="http://gedcomx.org/Persistent">https://familysearch.org/platform/records/collections/173</gx:identifier>
                </gx:sourceDescription>
            </gx:gedcomx>
        </content>
        <id>https://familysearch.org/ark:/61903/1:1:MMMM-7P1</id>
        <link rel="person" href="https://api.familysearch.org/platform/tree/persons/GRN-MN?flag=fsh"/>
        <gx:score>0.9824</gx:score>
        <title>FamilySearch Historical Collection 173</title>
        <updated>2018-12-01T08:11:07.759-07:00</updated>
    </entry>
    <entry>
        <fs:matchInfo collection="https://familysearch.org/platform/collections/records" status="http://familysearch.org/v1/Rejected"/>
        <gx:confidence>3</gx:confidence>
        <content type="application/x-gedcomx-v1+xml">
            <gx:gedcomx>
                <gx:sourceDescription resourceType="http://gedcomx.org/Collection">
                    <gx:title>FamilySearch Historical Collection 268</gx:title>
                    <gx:identifier type="http://gedcomx.org/Persistent">https://familysearch.org/platform/records/collections/268</gx:identifier>
                </gx:sourceDescription>
            </gx:gedcomx>
        </content>
        <id>https://familysearch.org/ark:/61903/1:1:MMMM-8NN</id>
        <link rel="person" href="https://api.familysearch.org/platform/tree/persons/GRN-MN?flag=fsh"/>
        <gx:score>0.01572</gx:score>
        <title>FamilySearch Historical Collection 268</title>
        <updated>2018-12-01T08:11:07.759-07:00</updated>
    </entry>
    <entry>
        <fs:matchInfo collection="https://familysearch.org/platform/collections/records" status="http://familysearch.org/v1/Pending"/>
        <gx:confidence>5</gx:confidence>
        <content type="application/x-gedcomx-v1+xml">
            <gx:gedcomx>
                <gx:sourceDescription resourceType="http://gedcomx.org/Collection">
                    <gx:title>FamilySearch Historical Collection 363</gx:title>
                    <gx:identifier type="http://gedcomx.org/Persistent">https://familysearch.org/platform/records/collections/363</gx:identifier>
                </gx:sourceDescription>
            </gx:gedcomx>
        </content>
        <id>https://familysearch.org/ark:/61903/1:1:MMMM-JC3</id>
        <link rel="person" href="https://api.familysearch.org/platform/tree/persons/GRN-MN?flag=fsh"/>
        <gx:score>1.8981</gx:score>
        <title>FamilySearch Historical Collection 363</title>
        <updated>2018-12-01T08:11:07.759-07:00</updated>
    </entry>
</feed>