Web Services Reference › Methods › Units and Groups › Unit Groups › OpenUnitGroupUserProfileMembersList

OpenUnitGroupUserProfileMembersList

The OpenUnitGroupUserProfileMembersList method opens a list of the user profiles that are members of the given unit group.

The method returns the total number of user profiles in the list, and a handle to the list that can be used for further calls to GetUnitGroupUserProfileMembers

Parameters

xsd:string sessionId (^m)

The session identifier.

xsd:string unitGroupId (^m)

The UUID of the unit group whose member user profiles are to be listed.

ArrayOfUserProfilePropertyFilter userProfilePropertyFilters

An array of user profile property filter definitions to limit the user profiles returned by the search.

UserProfilePropertiesRequired userProfilePropertiesRequired (^m)

The properties that will be required when getting a user profile from the list.

Return Values

xsd:long OpenListHandle

A numeric handle to a list of unit groups that can be passed to GetUnitGroupUserProfileMembers

xsd:long totalNoOfUserProfiles

The total number of user profiles in the list whose handle has been returned.

Remarks

None

More information:

UserProfilePropertiesRequired

UserProfilePropertyFilter