Member Service
Service for manipulating user memberships in a social group.
| Resource | Description |
|---|
| Delete | Delete the specified membership. |
| Get | Return the specified membership. |
| Select | Retrieve all memberships that match the specified criteria (at least one of groupID
and userID must be present). |
| Update | Update the state of the specified membership. |
Delete
Delete the specified membership.
DELETE http://domain:port/application_context/api/core/v2/members/{id}
Path Parameters
| Name | Type | Description | Default Value |
|---|
| id | long | the ID of the membership to be deleted | |
Get
Return the specified membership.
GET http://domain:port/application_context/api/core/v2/members/{id}
Path Parameters
| Name | Type | Description | Default Value |
|---|
| id | long | the ID of the membership to be returned | |
Select
Retrieve all memberships that match the specified criteria (at least one of groupID
and userID must be present).
GET http://domain:port/application_context/api/core/v2/members?groupID=long&userID=long&state=List&limit=int&offset=int
Query Parameters
| Name | Type | Description | Default Value |
|---|
| groupID | long | the group ID of the social group for which to select memberships | "-1" |
| userID | long | the user ID of the user for which to select memberships | "-1" |
| state | List | optional list of states used to filter the returned results (default is all states) | |
| limit | int | maximum number of memberships to be returned (default is 25) | "25" |
| offset | int | zero-relative offset of the first membership to be returned (default is 0) | "0" |
Update
Update the state of the specified membership.
Only the following state transitions are allowed, and only for the following people:
| From State |
To State |
Authorized For |
Notes |
| banned |
member |
Jive Admin, Group Admin |
Remove ban on participation in this group. |
| banned |
owner |
Jive Admin, Group Admin |
Remove ban on participation in this group, and make user a group admin. |
| member |
banned |
Jive Admin, Group Admin |
Ban participation in this group. |
| member |
owner |
Jive Admin, Group Admin |
Make user a group admin. |
| owner |
banned |
Jive Admin, Group Admin |
Ban participation in this group, remove admin privileges. |
| owner |
member |
Jive Admin, Group Admin |
Remove admin privileges. |
| pending |
banned |
Jive Admin, Group Admin |
Accept membership request, but ban user from participation. |
| pending |
member |
Jive Admin, Group Admin |
Accept membership request. |
| pending |
owner |
Jive Admin, Group Admin |
Accept membership request, make user a group admin. |
PUT http://domain:port/application_context/api/core/v2/members/{id}
Path Parameters
| Name | Type | Description | Default Value |
|---|
| id | long | the ID of the social group membership to be updated | |