Veetro Web Service Methods


Click here for a complete list of operations.

ExportAddressBookXLS

[Permission: Employee, Credentials: Contacts.DirectoryExport]
Exports the address book in XLSX format.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
flags:
keywords:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /xml HTTP/1.1
Host: admin.worketc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schema.veetro.com/ExportAddressBookXLS"

<?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>
    <ExportAddressBookXLS xmlns="http://schema.veetro.com">
      <flags>Sales_Lead or Customer or Supplier or Subscriber or Company or Person or Employee or Do_Not_Email or Inactive or Enable_Entry_Alerts or Disable_Login or Email_Bounced or Xero_Contact or Workgroup or Disable_Owner_Alerts or QuickBooks_Contact or Has_Avatar or PermissionInheritCompany or BirthDateYearOnly</flags>
      <keywords>string</keywords>
    </ExportAddressBookXLS>
  </soap:Body>
</soap:Envelope>
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>
    <ExportAddressBookXLSResponse xmlns="http://schema.veetro.com">
      <ExportAddressBookXLSResult>base64Binary</ExportAddressBookXLSResult>
    </ExportAddressBookXLSResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /xml HTTP/1.1
Host: admin.worketc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ExportAddressBookXLS xmlns="http://schema.veetro.com">
      <flags>Sales_Lead or Customer or Supplier or Subscriber or Company or Person or Employee or Do_Not_Email or Inactive or Enable_Entry_Alerts or Disable_Login or Email_Bounced or Xero_Contact or Workgroup or Disable_Owner_Alerts or QuickBooks_Contact or Has_Avatar or PermissionInheritCompany or BirthDateYearOnly</flags>
      <keywords>string</keywords>
    </ExportAddressBookXLS>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ExportAddressBookXLSResponse xmlns="http://schema.veetro.com">
      <ExportAddressBookXLSResult>base64Binary</ExportAddressBookXLSResult>
    </ExportAddressBookXLSResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /xml/ExportAddressBookXLS?flags=string&keywords=string HTTP/1.1
Host: admin.worketc.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<base64Binary xmlns="http://schema.veetro.com">base64Binary</base64Binary>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /xml/ExportAddressBookXLS HTTP/1.1
Host: admin.worketc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<base64Binary xmlns="http://schema.veetro.com">base64Binary</base64Binary>