Add
Add a new CoGroupMember (ie: a member of a CO group).
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| NewObjectResponse with | CoGroupMember added |
| CoGroupMember Request not provided in POST body | |
| ErrorResponse with details in | An error in one or more provided fields |
| Authentication required | |
| The specified CoGroup does not exist | |
| The specified CoPerson does not exist | |
| The specified CoPerson is already a member of the specified CoGroup | |
| Unknown error |
Delete
Remove a CoGroupMember.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoGroupMember deleted | |
|
| |
| Authentication required | |
|
| |
| Unknown error |
Edit
Edit an existing CoGroupMember.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoGroupMember updated | |
| CoGroupMember Request not provided in POST body | |
| ErrorResponse with details in | An error in one or more provided fields |
| Authentication required | |
| The specified CoGroup does not exist | |
| The specified CoPerson does not exist | |
| The specified CoPerson is already a member of the specified CoGroup | |
|
| |
| Unknown error |
View (all)
Retrieve all existing CoGroupMembers.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoGroupMember returned | |
| Authentication required | |
| Unknown error |
View (per CoGroup)
Retrieve CoGroupMembers attached to a CoGroup.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoGroupMember returned | |
| Authentication required | |
|
| |
| Unknown error |
View (per CoPerson)
Retrieve CoGroupMembers attached to a CoPerson. Available as of Registry v4.1.0.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoGroupMember returned | |
| Authentication required | |
|
| |
| Unknown error |
View (one)
Retrieve an existing CoGroupMember.
Request Format
Method |
|
|---|---|
URL |
|
Request Body |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| CoGroupMember returned | |
| Authentication required | |
|
| |
| Unknown error |
Notes
- Response format requested is ignored where response is only via HTTP status, but must still be provided.
See Also
- cm_co_group_members data model definition
- CoGroup API