GrooveMembers.Create2 Operation
The Create2 operation invites the specified member to the workspace. Optionally, this operation specifies the application creating and processing the invitation or specifies that the inviter must confirm the invitation after it is accepted.
HTTP Post URL
The HTTP Post URL targets a GrooveMembers service for a workspace. This URI is provided by the GrooveSpaces.Read operation in the Members element.
Input Message Header
GrooveRequestHeader specifies information common to all Groove Web Services, including the Groove Identity URL and the Groove Request key.
Input Message Parameters
<Member />
<RequireConfirmation />
<Silent />
<ApplicationURI />
<UserData />
<MessageBody />
| Element | Data type | Description |
|---|---|---|
Member |
Specifies the Identity URL of the contact to be invited to the workspace and the workspace role for the invitation. The Member.URI element provides the Identity URL and the Member.Role element provides the workspace role. Note that the Identity URL value starts with " |
|
RequireConfirmation |
|
If true, the member sending the invitation must confirm the acceptance before the invited user becomes a member of the workspace. |
Silent |
|
If true, no notification is displayed to the user when the invitation is received. |
ApplicationURI |
|
A URI that identifies the application that processes the workspace and invitation. To ensure that ApplicationURI values are unique, we recommend that the URI identifies the organization that is responsible for defining the structure of the workspace and invitation. The recommended URI has the general format of "urn:your-company-namespace:unique-name". |
UserData |
|
A string that enables the application instance initiating the invitation to communicate with the application instance receiving the information. For example, the application can include XML definitions identifying the names of the inviter and invitee in the UserData. |
MessageBody |
|
A string that is displayed to the Groove user in the invitation. If the Silent parameter is true, then the user is not notified about the invitation but can still read it in the message history. |
Output Message Header
GrooveResponseHeader specifies the Response key.
Return Value
None.
Remarks
This operation can only invite a contact that is known to the current user. If the URI specifies an identity that is not known to the current user, the operation will return a SOAP exception.
Note
This operation is available only on systems where Groove Web Services Version 2.1 is available. See Testing for Groove Web Services Version 2.1 for more information.
See Also
Reference
GrooveLocal.SendInvitationAlert Operation
GrooveLocal.SendInvitation Operation
GrooveMembers Web Service
GrooveSpaces.CreateInvitationFile Operation