public List<MOVEitUserInfo> UserListAdvanced(
	int Page,
	int EntriesPerPage,
	ClientUserPermissionFilter PermissionFilter,
	ClientUserStatusFilter StatusFilter,
	string GroupFilter,
	ClientUserSearchStringFilter SearchStringFilter,
	string SearchString,
	string OrgID
)

Public Function UserListAdvanced ( 
	Page As Integer,
	EntriesPerPage As Integer,
	PermissionFilter As ClientUserPermissionFilter,
	StatusFilter As ClientUserStatusFilter,
	GroupFilter As String,
	SearchStringFilter As ClientUserSearchStringFilter,
	SearchString As String,
	OrgID As String
) As List(Of MOVEitUserInfo)

public:
List<MOVEitUserInfo^>^ UserListAdvanced(
	int Page, 
	int EntriesPerPage, 
	ClientUserPermissionFilter PermissionFilter, 
	ClientUserStatusFilter StatusFilter, 
	String^ GroupFilter, 
	ClientUserSearchStringFilter SearchStringFilter, 
	String^ SearchString, 
	String^ OrgID
)

Parameters

Page

Type: SystemInt32
Page number to return (starting with 1). If the value provided is larger than the number of pages in the current list, the first page of results will be returned.

EntriesPerPage

Type: SystemInt32
Number of entries to return in each page of results (minimum 5, maximum 1000).

PermissionFilter

Type: MOVEit.DMZ.APIClientUserPermissionFilter
Permission filter code.

StatusFilter

Type: MOVEit.DMZ.APIClientUserStatusFilter
Status filter code.

GroupFilter

Type: SystemString
Group membership filter group name.

SearchStringFilter

Type: MOVEit.DMZ.APIClientUserSearchStringFilter
Search string filter code.

SearchString

Type: SystemString
Any search string, or blank string to skip the search string filter. Multiple character matching can be done with the "*" wildcard character; single character matching can be done with the "?" wildcard character.

OrgID

Type: SystemString
ID of the organization to list the users of.

Return Value

Returns an empty List if no users are found or null if the currently authorized user is not permitted to get this information. The OrgID argument only applies if the currently authorized user is a SysAdmin; by default this value is the same as the currently authorized user's OrgID.

This function allows more customization in which users are returned then the UserList(String) function. Most importantly, this function supports "paging", which allows programs to separate user lists into more manageable "pages", which contain only some of the results of the list. This is necessary when trying to list a large number of users, as MOVEit Transfer enforces a 1000 entry limit on the number of users that can be returned from a single listing, for performance reasons. The Page argument specifies the page number to return (starting with 1). The EntriesPerPage argument determines the number of entries that will be returned in each page (minimum 5, maximum 1000). Once the first page of the list has returned, the class-level UserListCount value will contain the total number of users available via the provided filters. The number of pages of users that can be retrieved can then be calculated using that value and the EntriesPerPage argument via the following algorithm:

if ((objAPI.UserListCount mod EntriesPerPage) > 0) 
{
    number_of_pages = (objAPI.UserListCount div EntriesPerPage) + 1
} 
else 
{
    number_of_pages = objAPI.UserListCount div EntriesPerPage
}

If the Page argument is set to a value higher than the total number of pages available, the first page of results will be returned.

Other capabilities of this function beyond UserList(String) include the ability to specify various filters and search strings to narrow down the list of returned users.

Reference