Veetro Web Service Methods


Click here for a complete list of operations.

GetEntitySearchResults2Simple

[Permission: Contacts, Credentials: Contacts.Directory]
Returns a paged set of simple contacts. Only returns Name, Email, Flags & RelatedCompanies.

Test

The test form is only available for requests from the local machine.

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

<?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>
    <GetEntitySearchResults2Simple xmlns="http://schema.veetro.com">
      <e>
        <SortResult>Name or Email or EntityID or DateLastModified or CreationDate or Company or Role or Viewed or Name_AlphaNumeric</SortResult>
        <AscendingResult>boolean</AscendingResult>
        <LastUpdatedUtc>dateTime</LastUpdatedUtc>
        <IncludeInactive>boolean</IncludeInactive>
      </e>
    </GetEntitySearchResults2Simple>
  </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>
    <GetEntitySearchResults2SimpleResponse xmlns="http://schema.veetro.com">
      <GetEntitySearchResults2SimpleResult>
        <RecordCount>int</RecordCount>
        <Description>string</Description>
        <SQL>string</SQL>
        <FetchSize>int</FetchSize>
        <Page>int</Page>
        <StartIndex>int</StartIndex>
        <EndIndex>int</EndIndex>
        <Results>
          <EntityResultOptimized>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <Surname>string</Surname>
            <RelatedCompanies xsi:nil="true" />
            <Tags xsi:nil="true" />
          </EntityResultOptimized>
          <EntityResultOptimized>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <Surname>string</Surname>
            <RelatedCompanies xsi:nil="true" />
            <Tags xsi:nil="true" />
          </EntityResultOptimized>
        </Results>
      </GetEntitySearchResults2SimpleResult>
    </GetEntitySearchResults2SimpleResponse>
  </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>
    <GetEntitySearchResults2Simple xmlns="http://schema.veetro.com">
      <e>
        <SortResult>Name or Email or EntityID or DateLastModified or CreationDate or Company or Role or Viewed or Name_AlphaNumeric</SortResult>
        <AscendingResult>boolean</AscendingResult>
        <LastUpdatedUtc>dateTime</LastUpdatedUtc>
        <IncludeInactive>boolean</IncludeInactive>
      </e>
    </GetEntitySearchResults2Simple>
  </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>
    <GetEntitySearchResults2SimpleResponse xmlns="http://schema.veetro.com">
      <GetEntitySearchResults2SimpleResult>
        <RecordCount>int</RecordCount>
        <Description>string</Description>
        <SQL>string</SQL>
        <FetchSize>int</FetchSize>
        <Page>int</Page>
        <StartIndex>int</StartIndex>
        <EndIndex>int</EndIndex>
        <Results>
          <EntityResultOptimized>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <Surname>string</Surname>
            <RelatedCompanies xsi:nil="true" />
            <Tags xsi:nil="true" />
          </EntityResultOptimized>
          <EntityResultOptimized>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <Surname>string</Surname>
            <RelatedCompanies xsi:nil="true" />
            <Tags xsi:nil="true" />
          </EntityResultOptimized>
        </Results>
      </GetEntitySearchResults2SimpleResult>
    </GetEntitySearchResults2SimpleResponse>
  </soap12:Body>
</soap12:Envelope>