This action retrieves a list of users stored within ExtraView.
Input
|
Class |
Name |
Type |
Required |
Details |
|
ExecuteUserSearchRequest |
userId |
String |
Yes |
The callers user name |
|
ExecuteUserSearchRequest |
password |
String |
Yes |
The callers password |
|
ExecuteUserSearchRequest |
disabled |
String |
No |
Include disabled users in results? { Y (yes), N (no), ONLY (only disabled users)} |
|
ExecuteUserSearchRequest |
filter |
String |
No |
This allows your to perform a wildcard pattern search for specific user records. The wildcard is * and you may have more then one of then in the pattern. (eg. *OB* or *OB* ) |
|
ExecuteUserSearchRequest |
filter_type |
String |
No |
If a filter is given, a filter_type must be given. Possible values ID, FIRST or LAST. This is the field you want the filter to work on. |
Output
|
Class |
Name |
Type |
Required |
Details |
|
ExecuteUserSearchResponse |
success |
boolean |
Yes |
True is succeeded False if failed |
|
ExecuteUserSearchResponse |
returnCode |
String |
No |
See Appendix for details |
|
ExecuteUserSearchResponse |
returnMessage |
String |
No |
Human readable message |
|
ExecuteUserSearchResponse |
users |
Array[] |
No |
A list of UserBeans |
|
User |
userId |
String |
Yes |
|
|
User |
userPassword |
String |
No |
|
|
User |
firstName |
String |
No |
|
|
User |
lastName |
String |
No |
|
|
User |
password |
String |
No |
|
|
User |
|
String |
No |
|
|
User |
jobTitle |
String |
No |
|
|
User |
companyName |
String |
No |
|
|
User |
addressLine1 |
String |
No |
|
|
User |
addressLine2 |
String |
No |
|
|
User |
city |
String |
No |
|
|
User |
state |
String |
No |
|
|
User |
postalCode |
String |
No |
|
|
User |
country |
String |
No |
|
|
User |
workPhoneNumber |
String |
No |
|
|
User |
homePhoneNumber |
String |
No |
|
|
User |
cellPhoneNumber |
String |
No |
|
|
User |
faxNumber |
String |
No |
|
|
User |
pagerNumber |
String |
No |
|
Example
public static void testExecuteUserSearch(EVReportServiceStub stub) {
try {
ExecuteUserSearchDocument reqEnvelope =
ExecuteUserSearchDocument.Factory.newInstance();
ExecuteUserSearchRequest request =
reqEnvelope.addNewExecuteUserSearch().addNewRequest();
request.setFilter("*" + ServiceClientHelper.ADMIN_USER_ID.toUpperCase() + "*");
request.setFilterType("ID");
request.setDisabled("Y");
request.setUserId(ServiceClientHelper.ADMIN_USER_ID);
request.setPassword(ServiceClientHelper.ADMIN_PASSWORD);
ExecuteUserSearchResponseDocument resEnvelope = stub.executeUserSearch(reqEnvelope);
ExecuteUserSearchResponse response =
resEnvelope.getExecuteUserSearchResponse().getReturn();
if (response.getSuccess()) {
System.out.println("success: [" + response.getReturnCode() + "] : " +
response.getReturnMessage());
} else {
System.out.println("failure: [" + response.getReturnCode() + "] : " +
response.getReturnMessage());
}
} catch (Exception e) {
e.printStackTrace();
System.err.println("nnn");
}
}