Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

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!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

/ admin / groupGetList2

  • Article
  • 1 minutes to read

Description

Invoke this operation to get a list of groups

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
--- --- --- ---

Request Parameters

The groupGetList2 method takes the following input parameters.

Note

When sending a JSON request payload to the API, the order of parameters is not significant. However, for XML request payloads, parameters must be provided in the exact order specified in this documentation to comply with input validation requirements.

Name Type Attributes Description
parent xs:string Optional To return only a list of children, specify the parent.
singleLevelOnly xs:boolean Optional Set this to true to return a single level of the tree only based on the parent.
optionsFilter groupOptionsType Optional Specify one or more options to filter return list by. If not specified then all items regardless of options are returned.
type Array<groupType> Optional If not specified then all types of group are returned. If you specify one or more types then only these types of groups are returned.
name xs:string Optional Filter list by group name that starts with specified string
orderBy orderByColumnType Optional Specify a column and direction to order by. If not specified then h_id column and ascending order is assumed.
pageInfo pageInfoType Optional Controls the paging. If element is not specified, paging is disabled

Response Parameters

Name Type Attributes Description
group Array<groupListType> Optional The list of groups.
maxPages numberType Optional A number indicating the maximum number of pages that could be returned.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document