Generate List of Users – Get Users

The List<User>GetUsers call retrieves a list of users.

Format of API String

List<User> GetUsers(int startIndex=0, out hasMore,string loginName, string password, string tenantCode)

Data That Needs to be Supplied to the API

• startIndex – in numeric format

• loginName, password and tenantCode – user credentials to authenticate the API connection

Output

API will result in a list of values

The sample output below has 2 users and hasMore is true, which means that there are more users in the system.

<Get_UsersResponse
<Get_UsersResult>
<User>
<UserLogin>benparker@planful.com</UserLogin>
<FirstName>Ben</FirstName>
<LastName>Parker</LastName>
<NavigationRoleName>Budget Administrator</NavigationRoleName>
<ReportingRole>RegularUser</ReportingRole>
<SupportRole>User</SupportRole>
<AuthenticationType>Native</AuthenticationType>
<Status>true</Status>
<SupportId>376970479</SupportId>
</User>
<User>
<UserLogin>benbradley@planful.com</UserLogin>
<FirstName>Ben</FirstName>
<LastName>Bradley</LastName>
<NavigationRoleName>Budget Administrator</NavigationRoleName>
<ReportingRole>RegularUser</ReportingRole>
<SupportRole>User</SupportRole>
<AuthenticationType>Native</AuthenticationType>
<Status>true</Status>
<SupportId>344912099</SupportId>
</User>
</Get_UsersResult>
<hasMore>true</hasMore>
</Get_UsersResponse>

Sample Calls

GetUsers(0,out has more,”planfuluser@gmail.com”,”planfulusertest”,”QATenant”) → Gets the users in the system from sequence no 0-4999.

If ‘hasmore’ is set to true after the API call, the API should be called again as follows:
GetUsers(5000,out hasMore,”planfuluser@gmail.com”,”planfulusertest”,”QATenant”) to get the next 5000 users.