Get Accounts Locations

Returns an AccountLocation array of possible locations defined in your Vorex account for a specified client accountId.

Request

URL	https://vorexlogin.com/GetAccountLocations

Type	Params	Values
HEAD	WSUserCredentials	Object
PARAM	accountId	Int
PARAM	outputMessage	OUTPUT String

WSUserCredentials - A custom authentication SOAP header object consisting of:
- UserName
- Password
- CompanyName
accountId - This represents the identification number of the account (client) for which you would like to retrieve the list of locations for.

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

<?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>
    <GetAccountLocations xmlns="https://vorexlogin.com/">
      <accountId>int</accountId>
    </GetAccountLocations>
  </soap:Body>
</soap:Envelope>

Response

Status

Response

Success

GetAccountLocationsResult:

Array of AccountLocation:
- LocationId (int)
- LocationName (string)
- IsMain (boolean)
- IsActive (boolean)
outputMessage:
- Empty String

Failure

GetAccountLocationsResult:

Returns Null

outputMessage:

"Failed to get Account Locations 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>
    <GetAccountLocationsResponse xmlns="https://vorexlogin.com/">
      <GetAccountLocationsResult>
        <AccountLocation>
          <LocationId>int</LocationId>
          <LocationName>string</LocationName>
          <IsMain>boolean</IsMain>
          <IsActive>boolean</IsActive>
        </AccountLocation>
        <AccountLocation>
          <LocationId>int</LocationId>
          <LocationName>string</LocationName>
          <IsMain>boolean</IsMain>
          <IsActive>boolean</IsActive>
        </AccountLocation>
      </GetAccountLocationsResult>
      <outputMessage>string</outputMessage>
    </GetAccountLocationsResponse>
  </soap:Body>
</soap:Envelope>