Ordinance Reservations

Beta: This resource is currently released as beta. The interface is considered stable, but there may be minor adjustments to functionality prior to release. Feedback is welcome.

Description

The ordinance reservations owned by the current user.

The count parameter specifies the number of tree persons for which the current user has at least one reservation. Any paging is by the number of tree persons, not the number of ordinance reservations. The response is a list of those tree persons with all of those tree person's ordinance reservations. The current user may have one or more than one ordinance reservation for any of the returned tree persons. Additionally other user's ordinance reservations may also be associated with any of the returned tree persons.

An single ordinance reservation contains the ordinances that would appear on a printed Family Card or the lines that appear in the FamilySearch UI reservation list. A Family Card is defined as BCIESP or SS. Multiple sealings are multiple cards.

Operations

GET - Read the ordinance reservations owned by the current user.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
count query The count of persons with ordinance reservations belonging to the current user to be returned. The current user may have 1 or more than 1 reservation for a given person. Default=40. Min=1. Max=40.
start query The index (zero-based) of the first person with an ordinance reservation belonging to the current user to be returned. Default=0. Min=0.
Status Codes
  • 200  -  Upon a successful read.
  • 204  -  When no ordinance reservations are currently owned by the current user.

POST - Create (if necessary) and assign the specified ordinance reservations to the current user or to the temple.

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
body request-body The ordinance reservations to create and assign.
Status Codes
  • 201  -  If the ordinance reservations were created and assigned successfully.

DELETE - Delete all ordinance reservations owned by the current user for the specified person id

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
pid query The person id to delete the ordinances reservations for Required.
Status Codes
  • 204  -  Upon a successful read.

Example Requests

Assign Ordinance Reservations to Temple How to assign ordinance reservations to the temple.
Create Ordinance Reservations How to create ordinance reservations for the current user.
Delete Ordinance Reservations for the Current User How to delete ordinance reservations for the current user.
Read Ordinance Reservations for the Current User How to read the ordinance reservations for the current user.

Change Language

Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.