WEBWebUserValidateLogin
| Initial Build | 2008.01 |
| xWeb | Web Method |
| Response Type | object |
The WEBWebUserValidateLogin web method validates a username login/email and password combination and returns a WebUserType if a match is found. This method can be used to log in a user to a site.
Parameters
The request has the following required parameters:
| Name | Type | Occurs | Description |
|---|---|---|---|
| LoginOrEmail | string | 0(R)..1 | The username or email address. |
| password | string | 0(R)..1 | The clear text password. |
Response
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>2aff28bb-29e5-452b-91e6-f8456b15969e</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBWebUserValidateLogin>
<ns:LoginOrEmail>bsmith</ns:LoginOrEmail>
<ns:password>123</ns:password>
</ns:WEBWebUserValidateLogin>
</soapenv:Body>
</soapenv:Envelope>
Sample Response
<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>f08c4fe8-d55b-46bf-a5e8-1e6594965330</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBWebUserValidateLoginResponse xmlns="http://www.avectra.com/2005/">
<WEBWebUserValidateLoginResult>
<CurrentKey>3ce2c530-2a15-41cf-b2db-ab8c9b326823</CurrentKey>
<Individual>
<ind_cst_key>3ce2c530-2a15-41cf-b2db-ab8c9b326823</ind_cst_key>
<ind_first_name>Darryl</ind_first_name>
<ind_last_name>Smith</ind_last_name>
<ind_full_name_cp>Darryl Smith</ind_full_name_cp>
<ind_token>59932455-73ab-46ac-aaaf-03ed681d75d9</ind_token>
</Individual>
<Customer>
<cst_recno>86984</cst_recno>
</Customer>
<Email>
<eml_address>jones@avectra.com</eml_address>
</Email>
<Business_Address>
<adr_city>East Orange</adr_city>
<adr_state>CT</adr_state>
<adr_post_code>04513</adr_post_code>
<adr_country>UNITED STATES</adr_country>
</Business_Address>
</WEBWebUserValidateLoginResult>
</WEBWebUserValidateLoginResponse>
</soap:Body>
</soap:Envelope>
JSON Method
POST /xWeb/JSON/WEBWebUserValidateLogin
DATA: JSON
{
"WEBWebUserValidateLogin": {
"LoginOrEmail": "{{emlAddressWebUserCreate}}",
"password" : "{{passwordWebUserCreate}}"
}
}
SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
"WebUserType": {
"CurrentKey": "c4a8bf15-005a-4c00-8184-bbb11d7bb012",
"Individual": {
"ind_cst_key": "c4a8bf15-005a-4c00-8184-bbb11d7bb012",
"ind_first_name": "Lorenza",
"ind_last_name": "Huel",
"ind_full_name_cp": "Lorenza Huel"
},
"Customer": {
"cst_recno": "7006"
},
"Email": {
"eml_address": "Sedrick_Wisoky54@example.com"
},
"Business_Address": {
"adr_city": "Taylor",
"adr_state": "VA",
"adr_post_code": "22102",
"adr_country": "UNITED STATES"
},
"Business_Phone_XRef": null,
"Business_Phone": null,
"Business_Fax_XRef": null,
"Business_Fax": null
}
}