WEBWebUserLogin
|
Initial Build |
2008.01 |
|
xWEB |
Web Method |
|
Response Type |
object |
This method can be used to log a Web User into an application. The method accepts a login name and clear-text password. See WebLogin for more information about xWeb user names.
Parameters
- LoginOrEmail (string). Login or email address.
- password (string). 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>2306bae2-4f6f-499c-8b8b-daffb79abb9b</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBWebUserLogin>
<ns:LoginOrEmail>bsmith@avectra.com</ns:LoginOrEmail>
<ns:password>123</ns:password>
</ns:WEBWebUserLogin>
</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>2306bae2-4f6f-499c-8b8b-daffb79abb9b</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBWebUserLoginResponse xmlns="http://www.avectra.com/2005/">
<WEBWebUserLoginResult>
<Individual>
<ind_cst_key>207d1a31-567e-4a97-ac21-a1923a092755</ind_cst_key>
<ind_first_name>Robert</ind_first_name>
<ind_last_name>Smith</ind_last_name>
<ind_full_name_cp>Robert Smith</ind_full_name_cp>
<ind_token>82d42250-e818-4c11-8d99-9d1036cdac06</ind_token>
</Individual>
<Customer>
<cst_recno>82896</cst_recno>
<cst_web_login>bsmith</cst_web_login>
</Customer>
<Email>
<eml_address>bsmith@avectra.com</eml_address>
</Email>
<Business_Address>
<adr_city>Falls Church</adr_city>
<adr_state>VA</adr_state>
<adr_post_code>22043</adr_post_code>
<adr_country>UNITED STATES</adr_country>
</Business_Address>
<Business_Phone>
<phn_number>7035067000</phn_number>
</Business_Phone>
<Business_Fax>
<fax_number>7035067001</fax_number>
</Business_Fax>
</WEBWebUserLoginResult>
</WEBWebUserLoginResponse>
</soap:Body>
</soap:Envelope>
JSON Method
POST Log a user in and retrieve the credentials. The response also contains the token for the customer record.
GET /xweb/JSON/WEBWebUserLogin?LoginOrEmail=jwatts1980+Test1@gmail.com&password=Pa$$w0rd
POST /xweb/JSON/WEBWebUserLogin?LoginOrEmail
Copy
DATA: JSON
{
"WEBWebUserLogin": {
"LoginOrEmail": "jwatts1980+Test1@gmail.com",
"password": "Pa$$w0rd"
}
}
Copy
SAMPLE RESULT
HTTP STATUS: 200
DATA - JSON
{
"WebUserType": {
"CurrentKey": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
"Individual": {
"ind_cst_key": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
"ind_first_name": "JasonTest1",
"ind_mid_name": "D",
"ind_last_name": "WattsTest1",
"ind_full_name_cp": "Mr. JasonTest1 D WattsTest1",
"ind_token": "28cfb306-32a6-457d-a494-4d0dc2c0148a"
},
"Customer": {
"cst_recno": "240656"
},
"Organization_XRef": null,
"Organization": null,
"Email": {
"eml_address": "jwatts1980+Test1@gmail.com"
},
"Website": null,
"Messaging": null,
"Business_Address_XRef": null,
"Business_Address": {
"adr_city": "Houston",
"adr_state": "TX",
"adr_post_code": "77433",
"adr_country": "UNITED STATES"
},
"Business_Address_State": null,
"Business_Address_Country": null,
"Business_Phone_XRef": null,
"Business_Phone": null,
"Business_Phone_Country": null,
"Business_Fax_XRef": null,
"Business_Fax": null,
"Business_Fax_Country": null,
"Home_Address_XRef": null,
"Home_Address": {
"ad2__adr_country": "UNITED STATES"
},
"Home_Address_State": null,
"Home_Address_Country": null,
"Home_Phone": null,
"Home_Phone_Country": null,
"Home_Phone_XRef": null,
"Home_Fax": null,
"Home_Fax_Country": null,
"Home_Fax_XRef": null,
"Address_Change_Log": null,
"TransferToCustomer": null,
"Individual_Custom_Demographics": null,
"Social_Links": null,
"source_code": null
}
}
FAQ
Special Characters in the Password Don't Work
Q. Customers with special characters in the password like & ' " < > don't work.
A. See Special Characters Do Not Work for explanation.