CET Groups

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 Groups resource provides the ability to create a CET group and get a list of CET groups that the current user is a member of.

A CET group is represented as a GedcomX FamilySearch extension Group.

Operations

POST - Create a CET group.

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 To create a CET group, ensure the group is in the 'groups' attribute of the FamilySearchPlatform object. The CET group must have a name. The group id and tree ids fields are ignored. All other fields are optional.
Status Codes
  • 201  -  The creation of the CET group was successful. Expect an X-Entity-Id header specifying the ID of the new group and a Location header containing the URL for the new group.
  • 429  -  If the request was throttled.

GET - Read the CET groups that the current user is a member of.

Produces - Specify a returned data format using the Accept header.

This method does not accept any parameters.

Status Codes
  • 200  -  Upon a successful read.
  • 204  -  Current user is not a member of any CET groups.

Example Requests

Create Group How to create a group.

Change Language

Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.