Veetro Web Service Methods


Click here for a complete list of operations.

GetEntitySearchResults

[Permission: Contacts] [deprecated] Returns a paged set of contacts. This is the preferred method for fetching contacts from your system. Valid EntitySortColumns are 'email', 'entityid' or 'name'. Set NameOnly to True for best performance.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
StartIndex:
FetchSize:
EntitySortColumn:
Ascending:
Flags:
Keywords:
NameOnly:

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

<?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>
    <GetEntitySearchResults xmlns="http://schema.veetro.com">
      <StartIndex>int</StartIndex>
      <FetchSize>int</FetchSize>
      <EntitySortColumn>string</EntitySortColumn>
      <Ascending>boolean</Ascending>
      <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</Flags>
      <Keywords>string</Keywords>
      <NameOnly>boolean</NameOnly>
    </GetEntitySearchResults>
  </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>
    <GetEntitySearchResultsResponse xmlns="http://schema.veetro.com">
      <GetEntitySearchResultsResult>
        <RecordCount>int</RecordCount>
        <Description>string</Description>
        <SQL>string</SQL>
        <FetchSize>int</FetchSize>
        <Page>int</Page>
        <StartIndex>int</StartIndex>
        <EndIndex>int</EndIndex>
        <Results>
          <EntityResult>
            <Mobile>string</Mobile>
            <Addresses xsi:nil="true" />
            <RelatedCompanies xsi:nil="true" />
            <Company xsi:nil="true" />
            <WorkgroupMembers xsi:nil="true" />
            <Events xsi:nil="true" />
            <Projects xsi:nil="true" />
            <Supports xsi:nil="true" />
            <Leads xsi:nil="true" />
            <Catalogs xsi:nil="true" />
            <InvoicesAndUnbilled xsi:nil="true" />
          </EntityResult>
          <EntityResult>
            <Mobile>string</Mobile>
            <Addresses xsi:nil="true" />
            <RelatedCompanies xsi:nil="true" />
            <Company xsi:nil="true" />
            <WorkgroupMembers xsi:nil="true" />
            <Events xsi:nil="true" />
            <Projects xsi:nil="true" />
            <Supports xsi:nil="true" />
            <Leads xsi:nil="true" />
            <Catalogs xsi:nil="true" />
            <InvoicesAndUnbilled xsi:nil="true" />
          </EntityResult>
        </Results>
      </GetEntitySearchResultsResult>
    </GetEntitySearchResultsResponse>
  </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>
    <GetEntitySearchResults xmlns="http://schema.veetro.com">
      <StartIndex>int</StartIndex>
      <FetchSize>int</FetchSize>
      <EntitySortColumn>string</EntitySortColumn>
      <Ascending>boolean</Ascending>
      <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</Flags>
      <Keywords>string</Keywords>
      <NameOnly>boolean</NameOnly>
    </GetEntitySearchResults>
  </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>
    <GetEntitySearchResultsResponse xmlns="http://schema.veetro.com">
      <GetEntitySearchResultsResult>
        <RecordCount>int</RecordCount>
        <Description>string</Description>
        <SQL>string</SQL>
        <FetchSize>int</FetchSize>
        <Page>int</Page>
        <StartIndex>int</StartIndex>
        <EndIndex>int</EndIndex>
        <Results>
          <EntityResult>
            <Mobile>string</Mobile>
            <Addresses xsi:nil="true" />
            <RelatedCompanies xsi:nil="true" />
            <Company xsi:nil="true" />
            <WorkgroupMembers xsi:nil="true" />
            <Events xsi:nil="true" />
            <Projects xsi:nil="true" />
            <Supports xsi:nil="true" />
            <Leads xsi:nil="true" />
            <Catalogs xsi:nil="true" />
            <InvoicesAndUnbilled xsi:nil="true" />
          </EntityResult>
          <EntityResult>
            <Mobile>string</Mobile>
            <Addresses xsi:nil="true" />
            <RelatedCompanies xsi:nil="true" />
            <Company xsi:nil="true" />
            <WorkgroupMembers xsi:nil="true" />
            <Events xsi:nil="true" />
            <Projects xsi:nil="true" />
            <Supports xsi:nil="true" />
            <Leads xsi:nil="true" />
            <Catalogs xsi:nil="true" />
            <InvoicesAndUnbilled xsi:nil="true" />
          </EntityResult>
        </Results>
      </GetEntitySearchResultsResult>
    </GetEntitySearchResultsResponse>
  </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/GetEntitySearchResults?StartIndex=string&FetchSize=string&EntitySortColumn=string&Ascending=string&Flags=string&Keywords=string&NameOnly=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"?>
<SearchResultOfEntityResult xmlns="http://schema.veetro.com">
  <RecordCount>int</RecordCount>
  <Description>string</Description>
  <SQL>string</SQL>
  <FetchSize>int</FetchSize>
  <Page>int</Page>
  <StartIndex>int</StartIndex>
  <EndIndex>int</EndIndex>
  <Results>
    <EntityResult>
      <Mobile>string</Mobile>
      <Addresses>
        <Address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Addresses>
      <RelatedCompanies>
        <BranchResult d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <BranchResult d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </RelatedCompanies>
      <Company>
        <Branches d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Company>
      <WorkgroupMembers>
        <Entity d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Entity d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </WorkgroupMembers>
      <Events>
        <Event d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Event d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Events>
      <Projects>
        <Project d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Project d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Projects>
      <Supports>
        <SupportCase d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SupportCase d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Supports>
      <Leads>
        <Lead d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Lead d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Leads>
      <Catalogs>
        <CatalogItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CatalogItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Catalogs>
      <InvoicesAndUnbilled>
        <anyType />
        <anyType />
      </InvoicesAndUnbilled>
    </EntityResult>
    <EntityResult>
      <Mobile>string</Mobile>
      <Addresses>
        <Address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Addresses>
      <RelatedCompanies>
        <BranchResult d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <BranchResult d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </RelatedCompanies>
      <Company>
        <Branches d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Company>
      <WorkgroupMembers>
        <Entity d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Entity d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </WorkgroupMembers>
      <Events>
        <Event d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Event d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Events>
      <Projects>
        <Project d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Project d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Projects>
      <Supports>
        <SupportCase d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SupportCase d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Supports>
      <Leads>
        <Lead d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Lead d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Leads>
      <Catalogs>
        <CatalogItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CatalogItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Catalogs>
      <InvoicesAndUnbilled>
        <anyType />
        <anyType />
      </InvoicesAndUnbilled>
    </EntityResult>
  </Results>
</SearchResultOfEntityResult>

HTTP POST

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

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

StartIndex=string&FetchSize=string&EntitySortColumn=string&Ascending=string&Flags=string&Keywords=string&NameOnly=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<SearchResultOfEntityResult xmlns="http://schema.veetro.com">
  <RecordCount>int</RecordCount>
  <Description>string</Description>
  <SQL>string</SQL>
  <FetchSize>int</FetchSize>
  <Page>int</Page>
  <StartIndex>int</StartIndex>
  <EndIndex>int</EndIndex>
  <Results>
    <EntityResult>
      <Mobile>string</Mobile>
      <Addresses>
        <Address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Addresses>
      <RelatedCompanies>
        <BranchResult d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <BranchResult d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </RelatedCompanies>
      <Company>
        <Branches d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Company>
      <WorkgroupMembers>
        <Entity d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Entity d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </WorkgroupMembers>
      <Events>
        <Event d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Event d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Events>
      <Projects>
        <Project d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Project d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Projects>
      <Supports>
        <SupportCase d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SupportCase d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Supports>
      <Leads>
        <Lead d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Lead d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Leads>
      <Catalogs>
        <CatalogItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CatalogItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Catalogs>
      <InvoicesAndUnbilled>
        <anyType />
        <anyType />
      </InvoicesAndUnbilled>
    </EntityResult>
    <EntityResult>
      <Mobile>string</Mobile>
      <Addresses>
        <Address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Addresses>
      <RelatedCompanies>
        <BranchResult d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <BranchResult d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </RelatedCompanies>
      <Company>
        <Branches d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Company>
      <WorkgroupMembers>
        <Entity d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Entity d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </WorkgroupMembers>
      <Events>
        <Event d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Event d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Events>
      <Projects>
        <Project d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Project d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Projects>
      <Supports>
        <SupportCase d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SupportCase d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Supports>
      <Leads>
        <Lead d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Lead d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Leads>
      <Catalogs>
        <CatalogItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CatalogItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Catalogs>
      <InvoicesAndUnbilled>
        <anyType />
        <anyType />
      </InvoicesAndUnbilled>
    </EntityResult>
  </Results>
</SearchResultOfEntityResult>