Query Register Users

API Type

Web Services

Description

Retrieves the list of registered users on theAgilePoint Server.

Syntax

public virtual RegisteredUser[] QueryRegisterUsers(string sqlWhereClause)

Parameters

Name	Description
sqlWhereClause	Definition: The where clause of the SQL statement you want to query. Type string Allowed Values: The where clause of a SQL statement.

Output

Returns a list of registered users.

Example

IWFAdminService svc = GetAdminService();
string sqlWhereClause = "DEPARTMENT in ('PublicUsers', ...)"

try
	{
    RegisteredUser[] registeredUsers =
    adminService.QueryRegisterUsers(sqlWhereClause);
    foreach (RegisteredUser user in registeredUsers)
	   {
       Console.WriteLine("User Name = '{0}', Email = '{1}'",
       user.UserName,user.EMailAddress);
	   }
	}

catch (Exception ex)
	{
    Console.WriteLine("Failed! " + ShUtil.GetSoapMessage(ex));
	}
      
/*
This example produces the following results:
User Name = 'DEMO\Author' Email = 'author@DEMO.com'
User Name = 'DEMO\Employee' Email = 'employee@DEMO.com'
*/

Supported Versions

3.2.0.4 and higher