WEBWebUserLoginByRememberMe
| Initial Build | 2011.01 |
| xWeb | Web Method |
| Response Type | WebUserType |
The WEBWebUserLoginByRememberMe web method logs in a Web User via the provided token. When this method is called, if the token is valid, then that token's value is updated to a new token value. This means that the same token value will no longer work.
Parameters
authenticationToken (string).
Response
WebUserType of the user, if the token was valid. The original token will be expired.
Exceptions
If the Token is not valid, then an exception will throw with the message "Authentication token was not validated".
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>**********************</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBWebUserLoginByRememberMe>
<ns:authenticationToken>9b0f9d6b-696e-495e-b93d-d6cd79816406</ns:authenticationToken>
</ns:WEBWebUserLoginByRememberMe>
</soapenv:Body>
</soapenv:Envelope>Sample Response
Observe that a new token for the customer, if needed, is returned in the ind_token property.
<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>b485b51b-4db4-45b5-98cb-0e77cb3c2bed</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBWebUserLoginByRememberMeResponse xmlns="http://www.avectra.com/2005/">
<WEBWebUserLoginByRememberMeResult>
<CurrentKey>f053df5a-0791-4080-bdfe-0bb8fe0b23a6</CurrentKey>
<Individual>
<ind_cst_key>f053df5a-0791-4080-bdfe-0bb8fe0b23a6</ind_cst_key>
<ind_first_name>Sam</ind_first_name>
<ind_last_name>Hopkins</ind_last_name>
<ind_full_name_cp>Sam Hopkins, ABC</ind_full_name_cp>
<ind_token>05a6f761-9f85-413d-a3de-fc8a17883e05</ind_token>
</Individual>
<Customer>
<cst_recno>111925</cst_recno>
</Customer>
<Email>
<eml_address>darryl.hopkins@abila.com</eml_address>
</Email>
<Business_Address>
<adr_country>UNITED STATES</adr_country>
</Business_Address>
<Business_Phone>
<phn_number>7774445555</phn_number>
</Business_Phone>
</WEBWebUserLoginByRememberMeResult>
</WEBWebUserLoginByRememberMeResponse>
</soap:Body>
</soap:Envelope>
JSON Method
POST /xWeb/JSON/WEBWebUserLoginByRememberMe
DATA: JSON
{
"WEBWebUserLoginByRememberMe": {
"authenticationToken": "{{authenticationTokenWebValidate}}"
}
}SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
"WebUserType": {
"CurrentKey": "a031885c-cf37-4a7f-ab87-f6cde1dc6490",
"Individual": {
"ind_cst_key": "a031885c-cf37-4a7f-ab87-f6cde1dc6490",
"ind_first_name": "Berniece",
"ind_last_name": "Corwin",
"ind_full_name_cp": "Berniece Corwin",
"ind_token": "6f579c1b-0957-4323-829e-f2dfb52227c7"
},
"Customer": {
"cst_recno": "7004"
},
"Email": {
"eml_address": "Mathias_Conroy@example.org"
},
"Business_Address": {
"adr_city": "West Seneca",
"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
}
}
More information