WEBWebUserValidateToken
Initial Build |
2008.01 |
xWEB |
Web Method |
Response Type |
object |
This method can be used to validate that a customer is logged in to eWeb by passing a token. This method can be used in a Single Sign On authentication.
Parameters
authenticationToken (string). Token.
Response
Exceptions
If the provided token is not valid, 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>2306bae2-4f6f-499c-8b8b-daffb79abb9b</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBWebUserValidateToken>
<ns:authenticationToken>82d42250-e818-4c11-8d99-9d1036cdac06</ns:authenticationToken>
</ns:WEBWebUserValidateToken>
</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>
<WEBWebUserValidateTokenResponse xmlns="http://www.avectra.com/2005/">
<WEBWebUserValidateTokenResult>
<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>
</WEBWebUserValidateTokenResult>
</WEBWebUserValidateTokenResponse>
</soap:Body>
</soap:Envelope>
JSON Method
POST /xWeb/JSON/WEBWebUserValidateToken
Copy
DATA: JSON
{
"WEBWebUserValidateToken": {
"authenticationToken": "{{eWebLoginToken}}"
}
}
Copy
SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
"WebUserType": {
"CurrentKey": "6ed68ef9-87b8-487d-8515-6ff6841c341e",
"Individual": {
"ind_cst_key": "6ed68ef9-87b8-487d-8515-6ff6841c341e",
"ind_first_name": "Ignacio",
"ind_mid_name": "Amely",
"ind_last_name": "Baumbach",
"ind_full_name_cp": "Ignacio Amely Baumbach",
"ind_token": "07df6da3-afe8-48fe-8338-3b9c9ecac751"
},
"Customer": {
"cst_recno": "713"
},
"Email": {
"eml_address": "Zander88@example.net"
},
"Business_Address": {
"adr_city": "Stracketown",
"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
}
}