Add

Add a new CoGroupMember (ie: a member of a CO group).

Request Format

Method

POST

URL

/co_group_members.<format>

Request Body

CoGroupMember Request

Response Format

HTTP Status

Response Body

Description

201 Added

NewObjectResponse with ObjectType of CoGroupMember

CoGroupMember added

400 Bad Request


CoGroupMember Request not provided in POST body

400 Invalid Fields

ErrorResponse with details in InvalidFields element

An error in one or more provided fields

401 Unauthorized


Authentication required

403 CoGroup Does Not Exist


The specified CoGroup does not exist

403 CoPerson Does Not Exist


The specified CoPerson does not exist

403 CoPerson Already Member


The specified CoPerson is already a member of the specified CoGroup

500 Other Error


Unknown error

Delete

Remove a CoGroupMember.

Request Format

Method

DELETE

URL

/co_group_members/<id>.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 Deleted


CoGroupMember deleted

400 Invalid Fields


id not provided

401 Unauthorized


Authentication required

404 Identifier Unknown


id not found

500 Other Error


Unknown error

Edit

Edit an existing CoGroupMember.

Request Format

Method

PUT

URL

/co_group_members/<id>.<format>

Request Body

CoGroupMember Request

Response Format

HTTP Status

Response Body

Description

200 OK


CoGroupMember updated

400 Bad Request


CoGroupMember Request not provided in POST body

400 Invalid Fields

ErrorResponse with details in InvalidFields element

An error in one or more provided fields

401 Unauthorized


Authentication required

403 CoGroup Does Not Exist


The specified CoGroup does not exist

403 CoPerson Does Not Exist


The specified CoPerson does not exist

403 CoPerson Already Member


The specified CoPerson is already a member of the specified CoGroup

404 Identifier Unknown


id not found

500 Other Error


Unknown error

View (all)

Retrieve all existing CoGroupMembers.

Request Format

Method

GET

URL

/co_group_members.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

CoGroupMember Response

CoGroupMember returned

401 Unauthorized


Authentication required

500 Other Error


Unknown error

View (per CoGroup)

Retrieve CoGroupMembers attached to a CoGroup. Optionally filter for or exclude group owners (as of Registry v4.4.0).

Request Format

Method

GET

URL

/co_group_members.<format>?cogroupid=<id>[&owner=true|false]

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

CoGroupMember Response

CoGroupMember returned

401 Unauthorized


Authentication required

404 CoGroup Unknown


id not found

500 Other Error


Unknown error

View (per CoPerson)

Retrieve CoGroupMembers attached to a CoPerson. Available as of Registry v4.1.0.

Request Format

Method

GET

URL

/co_group_members.<format>?copersonid=<id>

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

CoGroupMember Response

CoGroupMember returned

401 Unauthorized


Authentication required

404 CoPerson Unknown


id not found

500 Other Error


Unknown error

View (one)

Retrieve an existing CoGroupMember.

Request Format

Method

GET

URL

/co_group_members/<id>.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

CoGroupMember Response

CoGroupMember returned

401 Unauthorized


Authentication required

404 CoGroupMember Unknown


id not found

500 Other Error


Unknown error

Notes

  • Response format requested is ignored where response is only via HTTP status, but must still be provided.

See Also

  • No labels