UserGroupSearch
A complex data type that represents a user group search.
Elements
Condition
UserGroupCondition. Optional. The search condition. Specify this value of ConditionArray.
ConditionArray
ArrayOfUserGroupCondition. Optional. An array of search conditions. Specify this value of Condition.
ParentUserGroupName
String. Optional. The name of the parent user group of which the user is a member. Specify one of this value, ChildUserGroupName, WithRightsToChannelName, AssignedToUserName, ParentUserGroupId, ChildUserGroupId, WithRightsToChannelId, or AssignedToUserId.
ChildUserGroupName
String. Optional. The name of the child user group to which the user belongs. Specify one of this value, ParentUserGroupName, WithRightsToChannelName, AssignedToUserName, ParentUserGroupId, ChildUserGroupId, WithRightsToChannelId, or AssignedToUserId.
WithRightsToChannelName
String. Optional. The name of the channel to which the user is subscribed. Specify one of this value, ParentUserGroupName, ChildUserGroupName, AssignedToUserName, ParentUserGroupId, ChildUserGroupId, WithRightsToChannelId, or AssignedToUserId.
AssignedToUserName
String. Optional. The user name to which the user group is assigned. Specify one of this value, ParentUserGroupName, ChildUserGroupName, WithRightsToChannelName, ParentUserGroupId, ChildUserGroupId, WithRightsToChannelId, or AssignedToUserId.
ParentUserGroupId
String. Optional. The ID of the parent user group to which the group belongs. Specify one of this value, ParentUserGroupName, ChildUserGroupName, WithRightsToChannelName, AssignedToUserName, ChildUserGroupId, WithRightsToChannelId, or AssignedToUserId.
ChildUserGroupId
String. Optional. The ID f the child user group to which the group belongs. Specify one of this value, ParentUserGroupName, ChildUserGroupName, WithRightsToChannelName, AssignedToUserName, ParentUserGroupId, WithRightsToChannelId, or AssignedToUserId.
WithRightsToChannelId
String. Optional. The ID of the channel to which the user is subscribed. Specify one of this value, ParentUserGroupName, ChildUserGroupName, WithRightsToChannelName, AssignedToUserName, ParentUserGroupId, ChildUserGroupId, or AssignedToUserId.
AssignedToUserId
String. Optional. The user ID to which the user group is assigned. Specify one of this value, ParentUserGroupName, ChildUserGroupName, WithRightsToChannelName, AssignedToUserName, ParentUserGroupId, ChildUserGroupId, or WithRightsToChannelId.
FetchSize
Int. Optional. The maximum number of records to retrieve and return in a result set. The default value is 500.
FetchDirection
Boolean. Optional. If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.
CountLimit
Int. Optional. The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to ‑1.
FetchHandle
String. Optional. Retrieves more items from the result set. In the second and subsequent calls for data, specifies the same search criteria as in the original call.