Read Ordinances for multiple persons

This example request illustrates how to read the ordinances for a list of persons.

JSON

Request

GET /platform/ordinances/persons/ordinances?pid=PPPP-111&pid=PPPP-222&pid=PPPP-333
Accept: application/x-gedcomx-v1+json
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE
                
              

Response

HTTP/1.1 200 OK
Content-type: application/x-gedcomx-v1+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
                
                  {
  "links" : {
    "http://oauth.net/core/2.0/endpoint/token" : {
      "href" : "https://api.familysearch.org/oauth2/v3/token?flag=fsh"
    },
    "http://oauth.net/core/2.0/endpoint/authorize" : {
      "href" : "https://api.familysearch.org/oauth2/v3/authorization?flag=fsh"
    },
    "ordinances-policy" : {
      "href" : "https://api.familysearch.org/platform/ordinances/policy?flag=fsh"
    }
  },
  "persons" : [ {
    "id" : "PPPP-111",
    "ordinances" : [ {
      "type" : "http://churchofjesuschrist.org/Baptism",
      "status" : "http://familysearch.org/v1/Completed",
      "templeCode" : "Salt Lake",
      "completeDate": {
        "formal": "+1990-04-25"
      }
    } ]
  }, {
    "id" : "PPPP-222",
    "ordinances" : [ {
      "type" : "http://churchofjesuschrist.org/Endowment",
      "status" : "http://familysearch.org/v1/NeedMoreInformation",
      "statusReasons" : [ "http://familysearch.org/v1/InvalidName" ]
    } ]
  }, {
    "id" : "PPPP-333",
    "ordinances" : [ {
      "type" : "http://churchofjesuschrist.org/SealingToSpouse",
      "status" : "http://familysearch.org/v1/NeedPermission",
      "statusReasons" : [ "http://familysearch.org/v1/NeedPermission" ],
      "participants" : [ {
        "roleType" : "http://familysearch.org/v1/Spouse",
        "sexType" : "http://familysearch.org/v1/Female",
        "participant" : {
          "resource" : "https/api.familysearch.org/platform/tree/persons/MMMM-SSS",
          "resourceId" : "MMMM-SSS"
        }
      } ]
    } ]
  } ]
}
                
              

XML

Request

GET /platform/ordinances/persons/ordinances?pid=PPPP-111&pid=PPPP-222&pid=PPPP-333
Accept: application/x-gedcomx-v1+xml
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE
                
              

Response

HTTP/1.1 200 OK
Content-type: application/x-gedcomx-v1+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"?>
<gedcomx xmlns:fs="http://familysearch.org/v1/" xmlns="http://gedcomx.org/v1/" xmlns:atom="http://www.w3.org/2005/Atom">
    <link rel="http://oauth.net/core/2.0/endpoint/authorize" href="https://api.familysearch.org/oauth2/v3/authorization?flag=fsh"/>
    <link rel="http://oauth.net/core/2.0/endpoint/token" href="https://api.familysearch.org/oauth2/v3/token?flag=fsh"/>
    <link rel="ordinances-policy" href="https://api.familysearch.org/platform/ordinances/policy?flag=fsh"/>
    <person id="PPPP-111">
        <fs:ordinance type="http://churchofjesuschrist.org/Baptism" status="http://familysearch.org/v1/Completed">
            <fs:templeCode>Salt Lake</fs:templeCode>
            <fs:completeDate>
                <formal>+1990-04-25</formal>
            </fs:completeDate>
        </fs:ordinance>
    </person>
    <person id="PPPP-222">
        <fs:ordinance type="http://churchofjesuschrist.org/Endowment" status="http://familysearch.org/v1/NeedMoreInformation">
            <fs:statusReason>http://familysearch.org/v1/InvalidName</fs:statusReason>
        </fs:ordinance>
    </person>
    <person id="PPPP-333">
        <fs:ordinance type="http://churchofjesuschrist.org/SealingToSpouse" status="http://familysearch.org/v1/NeedPermission">
            <fs:statusReason>http://familysearch.org/v1/NeedPermission</fs:statusReason>
            <fs:participant roleType="http://familysearch.org/v1/Spouse" sexType="http://familysearch.org/v1/Female">
                <fs:participant resource="https/api.familysearch.org/platform/tree/persons/MMMM-SSS" resourceId="MMMM-SSS"/>
            </fs:participant>
        </fs:ordinance>
    </person>
</gedcomx>