How can we help?
{{docApp.searchError}}
{{product.name}}
Searching in {{docApp.searchFilterBySpecificBookTitle}}
{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}}
in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.
You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
-
{{resultItem.title}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Description
Invoke this operation to obtain the properties of the specified user group.
API Details
- Status:
- The required privilege level to invoke this method is
user
- The supported database role for this method is
slave
System Rights | Database Rights | Mail Rights | Calendar Rights |
---|---|---|---|
sys.a.manageGroups |
--- |
--- |
--- |
Request Parameters
The groupGetInfo method takes the following input parameters. It is important to note that the parameters must be passed to the method in the same order as they appear here in order to satisfy the requirement of the input validation checks.
Name | Type | Attributes | Description |
---|---|---|---|
id |
groupIdType |
Required | The id of the group to get information for. |
Response Parameters
Name | Type | Attributes | Description |
---|---|---|---|
id |
groupIdType |
Required | The id of the group. |
parentId |
groupIdType |
Optional | The id of the group. |
type |
groupType |
Optional | The type of the group. |
name |
groupNameType |
Optional | The name of the group. |
options |
groupOptionsType |
Optional | Set the options for this group. |
attrib1 |
xs:string |
Optional | The attribute one of the group. |
attrib2 |
xs:string |
Optional | The attribute two of the group. |
attrib3 |
xs:string |
Optional | The attribute three of the group. |
attrib4 |
xs:string |
Optional | The attribute four of the group. |
attrib5 |
xs:string |
Optional | The attribute five of the group. |
attrib6 |
xs:string |
Optional | The attribute six of the group. |
notes |
xs:string |
Optional | The description of the group. |
iconReference |
xs:anyURI |
Optional | A reference to the group icon |
hasChildGroups |
xs:boolean |
Optional | Set to true of this group has one or more child groups. |
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document