Invite Service
Service for manipulating invitations to a social group, sent by a Jive user,
and received by a Jive user or an email address.
Resource | Description |
---|
Delete | Delete the specified invitation. |
Get | Return the specified invitation. |
Put | Update the state of the specified invitation. |
Select | Retrieve all invitations that match the specified criteria (at least one of inviterID,
inviteeID, and groupID must be present). |
Delete
Delete the specified invitation.
DELETE http://domain:port/application_context/api/core/v2/invites/{id}
Path Parameters
Name | Type | Description | Default Value |
---|
id | long | the ID of the invitation to be rejected | |
Get
Return the specified invitation.
GET http://domain:port/application_context/api/core/v2/invites/{id}
Path Parameters
Name | Type | Description | Default Value |
---|
id | long | the ID of the invitation to be returned | |
Put
Update the state of the specified invitation.
Only the following state transitions are allowed, and only for the specified people:
From State |
To State |
Authorized For |
Notes |
processing, sent, or fulfilled |
accepted |
Invitee |
Causes the invitation to be accepted and group membership established. If the group is configured to require
administrator approval, and this invite was not sent by a Jive admin or group admin, the membership will still
be pending approval by a Jive or group administrator. |
processing, sent, or fulfilled |
resent |
Jive Admin, group admin, or the user who sent the invitation |
Causes the invitation to be resent to the corresponding invitee. |
any |
revoked |
Jive Admin, group admin, or the user who sent the invitation |
Causes the invitation to be revoked. |
PUT http://domain:port/application_context/api/core/v2/invites/{id}
Path Parameters
Name | Type | Description | Default Value |
---|
id | long | the ID of the invitation to be updated | |
Select
Retrieve all invitations that match the specified criteria (at least one of inviterID,
inviteeID, and groupID must be present).
GET http://domain:port/application_context/api/core/v2/invites?inviterID=long&inviteeID=long&groupID=long&limit=int&offset=int
Query Parameters
Name | Type | Description | Default Value |
---|
inviterID | long | the user ID of the inviter user | "-1" |
inviteeID | long | the user ID of the invitee user | "-1" |
groupID | long | the group ID of the social group for the selected invitations | "-1" |
limit | int | maximum number of invites to be returned (default is 25) | "25" |
offset | int | zero-relative offset of the first invite to be returned (default is 0) | "0" |