Groups.getList (Method)

Returns zero or more structures, each containing information about the groups that meet the filter criteria described by this member's arguments.

Returns:

Groups_GetList_Result (rowlimitedquery)

Arguments:

Name	Type	Required	Description
groupID	GroupID_NEG1	Optional. Defaults to '-1'.	The ID for a group known to the current CommonSpot customer or -1 for all groups.
groupType	GroupTypeFilter	Optional. Defaults to 'Normal'.	The type of groups to filter on, 'Normal', 'Visitor Context' or 'All'.
searchField	GroupSearchField_EmptyString	Optional. Defaults to 'GroupName'.	The field being searched. This is either 'GroupName', 'Description', or 'GroupType'.
searchOperator	SearchOperator_EmptyString	Optional. Defaults to 'Begins With'.	A search operator or an empty string. Values for this argument can be 'Begins With', 'Contains', 'Ends With', or 'Equals'.
searchString	PlainText	Optional. Defaults to an empty string.	The value CommonSpot searches for. This value is usually a group name or a group description.
orderBy	SQLOrderByClause	Optional. Defaults to 'groupName'.	The SQL 'order by' clause indicating which column is used as the returned data's sort key.
limit	QueryRowLimit	Optional. Defaults to '#this.LIMIT_TO_SCALABILITY_MAX#'.	A integer specifying one more than the maximum number of rows CommonSpot can return. If this value is 0, it returns all records. If it is -1, CommonSpot can return the number of records specified in the UI scalability setting.
excludeList	GroupIDList_EmptyString	Optional. Defaults to an empty string.	A comma-delimited list of one or more IDs of the groups that CommonSpot will exclude from a search. An empty string tells CommonSpot that is should not exclude groups.
permissionRestrictionsList	UserGroupPermissionRestrictionsList_EmptyString	Optional. Defaults to an empty string.	A comma-delimited list containing one or more user or group permissions restrictions or an empty string. If this argument is: * The empty string, no restrictions exist. * 'AdminOnly', CommonSpot returns all groups for which the user is an administrator. * 'NoAdmin', CommonSpot returns the groups for which there is no administrator.

Context:

License Requirements	None
Permission Requirements	Contributor
Deny Context	None
Require Context	None
Author Lock	(not required)
Transaction Logging	Transaction logging is disabled for this method
Customization	Customization is not supported for this method.

Error Codes:

Code	Error Message
24020	If a SearchField is specified, you must specify a valid SearchOperator.
24021	If a SearchOperator is specified, you must specify a valid SearchField.

Notes:

None