CET Group

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 Group resource provides the interface to read and delete a CET group.

A CET group is represented as a Gedcomx Group.

Operations

GET - Read a CET group.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
groupid path The id of the CET group to retrieve.
includeMembers query If true, the group members will be included in the response. Default=false.
Status Codes
  • 200  -  Upon a successful read.
  • 404  -  The requested CET group does not exist.
  • 410  -  The requested CET group has been deleted.
  • 429  -  If the request was throttled.

POST - Update 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
groupid path The id of the CET group to update.
body request-body The CET group to be updated. This post allows only one group to be updated at a time. The groupId in the URL must match the id of the group in the request body. You can modify the group name, description, and code of conduct using this POST operation. Passing an empty string for an attribute will remove the value for that attribute.
Status Codes
  • 204  -  The update was successful.
  • 404  -  The requested CET group does not exist.
  • 410  -  The requested CET group has been deleted.
  • 429  -  If the request was throttled.

DELETE - Delete a CET group.

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

Example Requests

We haven't created any example requests yet.

Change Language

Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.