Applies to QAComplete 12.61 SaaS, last modified on October 26, 2020

Returns the user ID by the email address of this user.

Parameters

The operation uses the following parameters:

AuthenticationData  :  AuthenticationData, required

An AuthenticationData object containing the login information for QAComplete.

Email  :  string, required

The email address of the user whose ID you want to get.

Result

An integer user ID, or 0 if there is no user with this email address.

Example

Sample Code

C#

string login = "john.smith@example.com";
string password = "p@ssword";

// The user whose ID you want to get
string email = "jane.doe@example.com";

ServiceSoapClient service = new ServiceSoapClient();

// Preparing AuthenticationData
LoginInfo loginInfo = service.GetLoginInfo("", login, password);
AuthenticationData authData = new AuthenticationData();
authData.AppCode = loginInfo.AppCode;
authData.UserId = loginInfo.UserId;
authData.ProjId = loginInfo.ProjId;
authData.DeptId = loginInfo.DeptId;
authData.PassCode = password;

// Get the user's e-mail
int anotherUserId = service.User_GetIdByEmail(authData, email);
Console.WriteLine(anotherUserId);

Java

String login = "john.smith@example.com";
String password = "p@ssword";

// The user e-mail whose ID you want to get
String email = "jane.doe@example.com";

ServiceSoap service = new Service().getServiceSoap12();

// Preparing AuthenticationData
LoginInfo loginInfo = service.getLoginInfo("", login, password);
AuthenticationData authData = new AuthenticationData();
authData.setAppCode(loginInfo.getAppCode());
authData.setUserId(loginInfo.getUserId());
authData.setPassCode(password);
authData.setDeptId(loginInfo.getDeptId());
authData.setProjId(loginInfo.getProjId());

// Get the user's e-mail
int anotherUserId = service.userGetIdByEmail(authData, email);
System.out.println(anotherUserId);

Sample Request XML

POST /psws/psws.asmx HTTP/1.1
Host: myteam.mysite.com
Content-Type: text/xml; charset=utf-8
Content-Length: 513 {Insert an appropriate value here}
SOAPAction: "http://www.pragmaticsw.com/User_GetIdByEmail"
 

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <User_GetIdByEmail xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>7154</DeptId>
        <ProjId>1032</ProjId>
        <UserId>25315</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <Email>jane.doe@example.com</Email>
    </User_GetIdByEmail>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

POST /psws/psws.asmx HTTP/1.1
Host: myteam.mysite.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 521 {Insert an appropriate value here}
 

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <User_GetIdByEmail xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>7154</DeptId>
        <ProjId>1032</ProjId>
        <UserId>25315</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <Email>jane.doe@example.com</Email>
    </User_GetIdByEmail>
  </soap12:Body>
</soap12:Envelope>

Sample Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: 393 {The server returns an appropriate value here}
 

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <User_GetIdByEmailResponse xmlns="http://www.pragmaticsw.com/">
      <User_GetIdByEmailResult>25310</User_GetIdByEmailResult>
    </User_GetIdByEmailResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 403 {The server returns an appropriate value here}
 

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <User_GetIdByEmailResponse xmlns="http://www.pragmaticsw.com/">
      <User_GetIdByEmailResult>25310</User_GetIdByEmailResult>
    </User_GetIdByEmailResponse>
  </soap12:Body>
</soap12:Envelope>

See Also

User_Add
User_GetEmailById
GetLoginInfo
GetLoginInfoByEntity
Users Operations
SOAP API Reference

Highlight search results