Get User List
Description
This public method will allow users to get a list of company users.
Support
Installation: ASP and Self host
| Level | Yes or No |
|---|---|
| Company Level | Yes |
| Project/Shell Level | No |
Prototype
public XMLObject getUserList(String shortname, String authcode, String filterCondition);
Parameters
| Parameter | Description |
|---|---|
| Shortname | identifier of the company, company's short name |
| Authcode | authentication key for the company, in text string |
| filterCondition | Information or condition to filter users list |
Return Value
Sample Method
If User Attributes form is defined:
getUserList("acme", "acme_authcode", "uuu_user_status=0 or uuu_user_status=1 or uuu_user_status=2");
If User Attributes form is not defined:
getUserList("acme", "acme_authcode", " status=0 or status=1 or status=2");
Additional Information
This method will allow users to get a list of company users based on the matching filter condition on either Username or First Name or Last Name or Email or Status. The XML element for these fields will be based on whether the User Attributes form has been defined, as shown below:
| Field | When User Attributes Form is Defined | When User Attributes Form is not Defined |
|---|---|---|
| Username | uuu_user_loginname | username |
| First Name | uuu_user_firstname | firstname |
| Lastname | uuu_user_lastname | lastname |
| uuu_user_email | ||
| Status | uuu_user_status | status |
Only one filter condition can be provided at a time using the "=" operator.
Method will return the list of Users with matching conditions.