Get Client Accounts

Returns an Account array of type "Client" defined in your Vorex account.

Request

URL	https://vorexlogin.com/GetClientAccounts

Type	Params	Values
HEAD	WSUserCredentials	Object
PARAM	outputMessage	OUTPUT String

WSUserCredentials - A custom authentication SOAP header object consisting of:
- UserName
- Password
- CompanyName

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/GetClientAccounts"

<?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:Header>
    <WSUserCredentials xmlns="https://vorexlogin.com/">
      <UserName>string</UserName>
      <Password>string</Password>
      <CompanyName>string</CompanyName>
    </WSUserCredentials>
  </soap:Header>
  <soap:Body>
    <GetClientAccounts xmlns="https://vorexlogin.com/" />
  </soap:Body>
</soap:Envelope>

Response

Status

Response

Success

GetClientAccountsResult:

Array of Account:
- AccountId (int)
- AccountName (string)
- IsActive (boolean)
- IsInternal (boolean)

outputMessage:

Empty String

Failure

GetClientAccountsResult:

Returns Null

outputMessage:

"Failed to get clients list."

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>
    <GetClientAccountsResponse xmlns="https://vorexlogin.com/">
      <GetClientAccountsResult>
        <Account>
          <AccountId>int</AccountId>
          <AccountName>string</AccountName>
          <IsActive>boolean</IsActive>
          <IsInternal>boolean</IsInternal>
        </Account>
        <Account>
          <AccountId>int</AccountId>
          <AccountName>string</AccountName>
          <IsActive>boolean</IsActive>
          <IsInternal>boolean</IsInternal>
        </Account>
      </GetClientAccountsResult>
      <outputMessage>string</outputMessage>
    </GetClientAccountsResponse>
  </soap:Body>
</soap:Envelope>