GrooveTools.ReadPermissions Operation

Article
10/16/2013

The ReadPermissions operation returns the tool permissions available to the specified role in the targeted tool or returns the list of available permissions for the targeted tool.

HTTP Post URL

The HTTP Post URL targets the GrooveTools service for a tool. This URI is provided by the Read operation in the URI 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

<Role />
<AllPermissions />

Element	Data type	Description
Role	xs:string	Specifies the workspace role with one of the following strings: "$Telespace.Manager" for manager, "$Telespace.Member" for participant, and "$Telespace.Guest" for guest.
AllPermissions	`xs:boolean`	If true, specifies that all possible permissions should be returned. If false, specifies that only the permissions enabled for the specified role should be returned.

Output Message Header

GrooveResponseHeader specifies the Response key.

Return Value

<ReadPermissionsResult>
  <!-- Array of --> <Permission />
</ReadPermissionsResult>

Element	Data type	Description
ReadPermissionsResult	Array of `xs:string`	Strings representing the tool permissions available to the specified role or all possible tool permissions.

Remarks

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.