CET

Prototype: This resource is currently in a prototype development state. It may or may not be operational and the interface may change prior to release. Feedback is welcome.

Description

The Tree resource provides the interface to read, update, and delete a CET. A CET is represented as a GedcomX FamilySearch extension Tree.

Operations

GET - Read a CET.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
tid path The id of the CET to retrieve.
Status Codes
  • 200  -  Upon a successful read.
  • 404  -  The requested CET does not exist.
  • 410  -  The requested CET has been deleted.
  • 429  -  If the request was throttled.

POST - Update a CET tree.

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
tid path The id of the CET to update.
body request-body The CET to be updated must be in the trees attribute of the FamilySearchPlatform object. This post allows only one tree to be updated at a time. The treeId in the URL must match the id of the tree in the request body. You can modify the startingPersonId, hidden, private, name, description, ownerAccess and groupAccess fields using this POST operation. Passing an empty string for an attribute will remove the value for that attribute. Hidden can only be set to false.
Status Codes
  • 204  -  The CET has been successfully updated.
  • 404  -  The requested CET does not exist.
  • 410  -  The requested CET has been deleted.
  • 429  -  If the request was throttled.

DELETE - Delete a CET.

Produces - Specify a returned data format using the Accept header.
  • */*
Parameters
Name Type Description
tid path The id of the CET to delete.
Status Codes
  • 204  -  The requested CET has been deleted.
  • 404  -  The requested CET does not exist.
  • 409  -  The attempt to delete the requested CET was made while another request committed a change to the CET.
  • 429  -  If the request was throttled.

Example Requests

Update CET How to update a CET.

Change Language

Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.