getUserByEmail
This action retrieves the first found user within ExtraView for a given email address. Note that if the same email address is used for different users, only the first is returned.
Input
|
Class |
Name |
Type |
Required |
Details |
|
GetUserByEmailRequest |
userId |
String |
Yes |
The callers user name |
|
GetUserByEmailRequest |
password |
String |
Yes |
The callers password |
|
GetUserByEmailRequest |
|
String |
Yes |
The email address of the user your getting |
Output
|
Class |
Name |
Type |
Required |
Details |
|
GetUserByEmailResponse |
success |
boolean |
Yes |
True is succeeded False if failed |
|
GetUserByEmailResponse |
returnCode |
String |
No |
See Appendix for details |
|
GetUserByEmailResponse |
returnMessage |
String |
No |
Human readable message |
|
GetUserByEmailResponse |
user |
Object |
No |
A Single UserBean Object |
|
UserBean |
userId |
String |
Yes |
|
|
UserBean |
userPassword |
String |
No |
|
|
UserBean |
firstName |
String |
No |
|
|
UserBean |
lastName |
String |
No |
|
|
UserBean |
password |
String |
No |
|
|
UserBean |
|
String |
No |
|
|
UserBean |
jobTitle |
String |
No |
|
|
UserBean |
companyName |
String |
No |
|
|
UserBean |
addressLine1 |
String |
No |
|
|
UserBean |
addressLine2 |
String |
No |
|
|
UserBean |
city |
String |
No |
|
|
UserBean |
state |
String |
No |
|
|
UserBean |
postalCode |
String |
No |
|
|
UserBean |
country |
String |
No |
|
|
UserBean |
workPhoneNumber |
String |
No |
|
|
UserBean |
homePhoneNumber |
String |
No |
|
|
UserBean |
cellPhoneNumber |
String |
No |
|
|
UserBean |
faxNumber |
String |
No |
|
|
UserBean |
pagerNumber |
String |
No |
|
Example
public static void testGetUserByEmail(EVUserServiceStub stub) {
try {
GetUserByEmailDocument reqEnvelope = GetUserByEmailDocument.Factory.newInstance();
GetUserByEmailRequest request = reqEnvelope.addNewGetUserByEmail().addNewRequest();
request.setEmail(ServiceClientHelper.generatedEmail);
request.setUserId(ServiceClientHelper.ADMIN_USER_ID);
request.setPassword(ServiceClientHelper.ADMIN_PASSWORD);
GetUserByEmailResponseDocument resEnvelope = stub.getUserByEmail(reqEnvelope);
GetUserByEmailResponse response =
resEnvelope.getGetUserByEmailResponse().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");
}
}