Export Accounts And Contacts

Returns an array of accounts and, if requested, related data such as account locations, contacts, contacts phones and emails. The result set is returned in a data set format having various data tables filled in case the data is requested.

Request

URL	https://vorexlogin.com/ExportAccountsAndContacts

Type	Params	Values
HEAD	WSUserCredentials	Object
PARAM	dateFrom	dateTime
PARAM	dateTo	dateTime
PARAM	clientNames	string
PARAM	businessTypes	string
PARAM	accountTypes	string
PARAM	withLocations	boolean
PARAM	withContacts	boolean
PARAM	outputMessage	OUTPUT String

WSUserCredentials - A custom authentication SOAP header object consisting of:
- UserName
- Password
- CompanyName
clientNames - Specify the clients(s) value(s) by which to filter accounts based on. For multiple clients you have to separate by Comma (,). If Null or Empty ("") this will be ignored.
dateFrom - Specify the earliest account acquired date. If Null this will be ignored.
dateTo - Specify the latest account acquired date. If Null this will be ignored.
businessTypes - Specify the business type(s) value(s) by which to filter accounts based on. For multiple business types you have to separate by Comma (,). If Null or Empty ("") this will be ignored.
accountTypes - Specify the account type(s) value(s) by which to filter accounts based on. For multiple account types you have to separate by Comma (,). If Null or Empty ("") this will be ignored.
withLocations - Boolean value to specify if the accounts locations should be loaded as well.
withContacts - Boolean value to specify if the accounts Contacts should be loaded as well.

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

<?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>
    <ExportAccountsAndContacts xmlns="https://vorexlogin.com/">
      <dateFrom>dateTime</dateFrom>
      <dateTo>dateTime</dateTo>
      <clientNames>string</clientNames>
      <businessTypes>string</businessTypes>
      <accountTypes>string</accountTypes>
      <withLocations>boolean</withLocations>
      <withContacts>boolean</withContacts>
    </ExportAccountsAndContacts>
  </soap:Body>
</soap:Envelope>

Response

Status

Response

Success

ExportAccountsAndContactsResult:

DataSet

outputMessage:

Empty String

Failure

ExportAccountsAndContactsResult:

Returns Null

outputMessage:

"An Error has Occurred while processing the request."

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>
    <ExportAccountsAndContactsResponse xmlns="https://vorexlogin.com/">
      <ExportAccountsAndContactsResult>
        <xsd:schema>schema</xsd:schema>xml</ExportAccountsAndContactsResult>
      <outputMessage>string</outputMessage>
    </ExportAccountsAndContactsResponse>
  </soap:Body>
</soap:Envelope>