WEBWebUserFindUsersByEmail

Initial Build	2008.01
xWeb	Web Method
Response Type	XML Node

This method can be used to return a customer's information from their e-mail address.

Parameters

emailToMatch (string). The email address to search. The match puts a wildcard before and after the search expression.

Return

XmlNode

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<ns:Token>2306bae2-4f6f-499c-8b8b-daffb79abb9b</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBWebUserFindUsersByDomain>
<ns:domainToMatch>avectra.com</ns:domainToMatch>
</ns:WEBWebUserFindUsersByDomain>
</soapenv:Body>
</soapenv:Envelope>

Sample Response

Shortened for brevity.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<AuthorizationToken xmlns="http://www.avectra.com/2005/">
<Token>2306bae2-4f6f-499c-8b8b-daffb79abb9b</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBWebUserFindUsersByDomainResponse xmlns="http://www.avectra.com/2005/">
<WEBWebUserFindUsersByDomainResult>
<Results recordReturn="145">
<Result>
<cst_key>ec28369e-664f-4055-959b-9e4817d790ee</cst_key>
<username>82781</username>
<ind_first_name>Silviu</ind_first_name>
<ind_last_name>SterianTwenty</ind_last_name>
<ind_full_name_cp>Silviu SterianTwenty</ind_full_name_cp>
<cst_web_login>[e-mail]</cst_web_login>
<cst_eml_address_dn>[e-mail]</cst_eml_address_dn>
<adr_city_state_code>Falls Church, AZ  22102</adr_city_state_code>
</Result>
<Result>
<cst_key>05b456a0-49ed-4b62-94e9-f6325051d170</cst_key>
<username>82865</username>
<ind_first_name>asdf</ind_first_name>
<ind_last_name>asfd</ind_last_name>
<ind_full_name_cp>asdf asfd</ind_full_name_cp>
<cst_web_login/>
<cst_eml_address_dn>[e-mail]</cst_eml_address_dn>
<adr_city_state_code>asfd, AK</adr_city_state_code>
</Result>
<Result>
<cst_key>057ad9c2-09da-49d2-ae58-a3b2349f81a3</cst_key>
<username>82665</username>
<ind_first_name>olivia</ind_first_name>
<ind_last_name>bilbyeighteen</ind_last_name>
<ind_full_name_cp>olivia bilbyeighteen</ind_full_name_cp>
<cst_web_login/>
<cst_eml_address_dn>[e-mail]</cst_eml_address_dn>
<adr_city_state_code>mclean, VA  22102</adr_city_state_code>
</Result>
</Results>
</WEBWebUserFindUsersByDomainResult>
</WEBWebUserFindUsersByDomainResponse>
</soap:Body>
</soap:Envelope>

 

JSON Method

Searches for an email address that may be used on an individual record.

Note this does not look at organization records.

Under-the-hood, the database adds a wildcard character. So "[e-mail]" will also match "[e-mail]".

GET /xweb/JSON/WEBWebUserFindUsersByEmail?emailToMatch=[e-mail]

POST /xweb/JSON/WEBWebUserFindUsersByEmail

DATA: JSON
{
    "WEBWebUserFindUsersByEmail": {
        "emailToMatch": "[e-mail]"
    }
}

SAMPLE RESULT: NONE
HTTP STATUS: 200
{
    "Results": {
        "@recordReturn": "0"
    }
}

SAMPLE RESULT: 1
HTTP STATUS: 200
{
    "Results": {
        "@recordReturn": "1",
        "Result": [
            {
                "cst_key": "87d5b91f-19f7-438d-85a4-47357cf121e4",
                "username": "122546",
                "ind_first_name": "Cassie",
                "ind_last_name": "Mitcheltree",
                "ind_full_name_cp": "Cassie Mitcheltree",
                "cst_web_login": "[e-mail]",
                "cst_eml_address_dn": "[e-mail]",
                "adr_city_state_code": "Milton, PA 17847-0000"
            }
        ]
    }
}   

SAMPLE RESULT: MULTIPLE
HTTP STATUS: 200
{
    "Results": {
        "@recordReturn": "2",
        "Result": [
            {
                "cst_key": "87d5b91f-19f7-438d-85a4-47357cf121e4",
                "username": "122546",
                "ind_first_name": "Cassie",
                "ind_last_name": "Mitcheltree",
                "ind_full_name_cp": "Cassie Mitcheltree",
                "cst_web_login": "[e-mail]",
                "cst_eml_address_dn": "[e-mail]",
                "adr_city_state_code": "Milton, PA 17847-0000"
            },
            {
                "cst_key": "c1914a54-9cc8-4894-a7fc-ed3d31b565a9",
                "username": "19659",
                "ind_first_name": "Jeffrey",
                "ind_last_name": "Kimball",
                "ind_full_name_cp": "Mr. Jeffrey L. Kimball",
                "cst_web_login": "[e-mail]",
                "cst_eml_address_dn": "[e-mail]",
                "adr_city_state_code": "Milton, PA 17847-9756"
            }
        ]
    }
}