Next Topic

Previous Topic

Book Contents

Authenticate

Authenticates the connecting user within Vorex. Returns a boolean representing whether he is authenticated or not.

Request

URL

https://vorexlogin.com/Authenticate

Type

Params

Values

Body

companyName

string

Body

userName

string

Body

password

string

Example Request

POST /WS/OpenAPI.asmx HTTP/1.1
Host: vorexlogin.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://vorexlogin.com/Authenticate"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<Authenticate xmlns="https://vorexlogin.com/">
<companyName>string</companyName>
<userName>string</userName>
<password>string</password>
</Authenticate>
</soap:Body>
</soap:Envelope>

Response

Type

Response

Boolean

AuthenticateResult

Example Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<AuthenticateResponse xmlns="https://vorexlogin.com/">
<AuthenticateResult>boolean</AuthenticateResult>
</AuthenticateResponse>
</soap:Body>
</soap:Envelope>