Veetro Web Service Methods


Click here for a complete list of operations.

Search

[Permission: Any Authenticated]
Searches entire system based on keywords using an optimized Lucene index search engine.

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

<?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>
    <Search xmlns="http://schema.veetro.com">
      <q>
        <Keywords>string</Keywords>
        <Types>
          <SearchIndexType>Any or Event or ToDo or Journal or Invoice or Project or Support_Case or Disbursement or Notation or Message or Subscription or Product or Document or Quote or Credit_Invoice or IM or Withdrawal or Deposit or Refund or Person or Company or Employee or Lead or BlogPost or CatalogItem or Proposal or Article or Workgroup or Discussion</SearchIndexType>
          <SearchIndexType>Any or Event or ToDo or Journal or Invoice or Project or Support_Case or Disbursement or Notation or Message or Subscription or Product or Document or Quote or Credit_Invoice or IM or Withdrawal or Deposit or Refund or Person or Company or Employee or Lead or BlogPost or CatalogItem or Proposal or Article or Workgroup or Discussion</SearchIndexType>
        </Types>
        <EntityIDs>
          <int>int</int>
          <int>int</int>
        </EntityIDs>
        <WhereOwnerOrMember>boolean</WhereOwnerOrMember>
        <DateFrom>string</DateFrom>
        <DateTo>string</DateTo>
        <PageSize>int</PageSize>
        <Page>int</Page>
        <Sort>Rank or NewestFirst or OldestFirst or Title</Sort>
      </q>
    </Search>
  </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>
    <SearchResponse xmlns="http://schema.veetro.com">
      <SearchResult>
        <Status>OK or SearchServiceOffline or InternalError</Status>
        <Feedback>string</Feedback>
        <Request>
          <PageSize>int</PageSize>
          <RecordCount>int</RecordCount>
          <Page>int</Page>
          <Sort>Rank or NewestFirst or OldestFirst or Title</Sort>
          <TypeFilter>
            <SearchIndexType>Any or Event or ToDo or Journal or Invoice or Project or Support_Case or Disbursement or Notation or Message or Subscription or Product or Document or Quote or Credit_Invoice or IM or Withdrawal or Deposit or Refund or Person or Company or Employee or Lead or BlogPost or CatalogItem or Proposal or Article or Workgroup or Discussion</SearchIndexType>
            <SearchIndexType>Any or Event or ToDo or Journal or Invoice or Project or Support_Case or Disbursement or Notation or Message or Subscription or Product or Document or Quote or Credit_Invoice or IM or Withdrawal or Deposit or Refund or Person or Company or Employee or Lead or BlogPost or CatalogItem or Proposal or Article or Workgroup or Discussion</SearchIndexType>
          </TypeFilter>
          <Fields>
            <SearchIndexField xsi:nil="true" />
            <SearchIndexField xsi:nil="true" />
          </Fields>
          <EntityIDs>
            <int>int</int>
            <int>int</int>
          </EntityIDs>
          <DateFrom>dateTime</DateFrom>
          <DateTo>dateTime</DateTo>
        </Request>
        <Items>
          <SearchIndexResult>
            <Score>float</Score>
            <VeetroID>int</VeetroID>
            <VeetroBaseType>Entry or Notation or Message or Document or Invoice or Transaction or Entity or Lead or BlogPost or Blog or InvoiceItem or CatalogItem or Proposal or Article or Activity or CatalogItemCategory or SupportCaseType or MailQueue or Calendar or CustomView or Report or ReportWidgetCategory or Template</VeetroBaseType>
            <SearchIndexType>Any or Event or ToDo or Journal or Invoice or Project or Support_Case or Disbursement or Notation or Message or Subscription or Product or Document or Quote or Credit_Invoice or IM or Withdrawal or Deposit or Refund or Person or Company or Employee or Lead or BlogPost or CatalogItem or Proposal or Article or Workgroup or Discussion</SearchIndexType>
            <TypeFlags>int</TypeFlags>
            <Title>string</Title>
            <AbstractHtml>string</AbstractHtml>
            <Fields xsi:nil="true" />
          </SearchIndexResult>
          <SearchIndexResult>
            <Score>float</Score>
            <VeetroID>int</VeetroID>
            <VeetroBaseType>Entry or Notation or Message or Document or Invoice or Transaction or Entity or Lead or BlogPost or Blog or InvoiceItem or CatalogItem or Proposal or Article or Activity or CatalogItemCategory or SupportCaseType or MailQueue or Calendar or CustomView or Report or ReportWidgetCategory or Template</VeetroBaseType>
            <SearchIndexType>Any or Event or ToDo or Journal or Invoice or Project or Support_Case or Disbursement or Notation or Message or Subscription or Product or Document or Quote or Credit_Invoice or IM or Withdrawal or Deposit or Refund or Person or Company or Employee or Lead or BlogPost or CatalogItem or Proposal or Article or Workgroup or Discussion</SearchIndexType>
            <TypeFlags>int</TypeFlags>
            <Title>string</Title>
            <AbstractHtml>string</AbstractHtml>
            <Fields xsi:nil="true" />
          </SearchIndexResult>
        </Items>
      </SearchResult>
    </SearchResponse>
  </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>
    <Search xmlns="http://schema.veetro.com">
      <q>
        <Keywords>string</Keywords>
        <Types>
          <SearchIndexType>Any or Event or ToDo or Journal or Invoice or Project or Support_Case or Disbursement or Notation or Message or Subscription or Product or Document or Quote or Credit_Invoice or IM or Withdrawal or Deposit or Refund or Person or Company or Employee or Lead or BlogPost or CatalogItem or Proposal or Article or Workgroup or Discussion</SearchIndexType>
          <SearchIndexType>Any or Event or ToDo or Journal or Invoice or Project or Support_Case or Disbursement or Notation or Message or Subscription or Product or Document or Quote or Credit_Invoice or IM or Withdrawal or Deposit or Refund or Person or Company or Employee or Lead or BlogPost or CatalogItem or Proposal or Article or Workgroup or Discussion</SearchIndexType>
        </Types>
        <EntityIDs>
          <int>int</int>
          <int>int</int>
        </EntityIDs>
        <WhereOwnerOrMember>boolean</WhereOwnerOrMember>
        <DateFrom>string</DateFrom>
        <DateTo>string</DateTo>
        <PageSize>int</PageSize>
        <Page>int</Page>
        <Sort>Rank or NewestFirst or OldestFirst or Title</Sort>
      </q>
    </Search>
  </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>
    <SearchResponse xmlns="http://schema.veetro.com">
      <SearchResult>
        <Status>OK or SearchServiceOffline or InternalError</Status>
        <Feedback>string</Feedback>
        <Request>
          <PageSize>int</PageSize>
          <RecordCount>int</RecordCount>
          <Page>int</Page>
          <Sort>Rank or NewestFirst or OldestFirst or Title</Sort>
          <TypeFilter>
            <SearchIndexType>Any or Event or ToDo or Journal or Invoice or Project or Support_Case or Disbursement or Notation or Message or Subscription or Product or Document or Quote or Credit_Invoice or IM or Withdrawal or Deposit or Refund or Person or Company or Employee or Lead or BlogPost or CatalogItem or Proposal or Article or Workgroup or Discussion</SearchIndexType>
            <SearchIndexType>Any or Event or ToDo or Journal or Invoice or Project or Support_Case or Disbursement or Notation or Message or Subscription or Product or Document or Quote or Credit_Invoice or IM or Withdrawal or Deposit or Refund or Person or Company or Employee or Lead or BlogPost or CatalogItem or Proposal or Article or Workgroup or Discussion</SearchIndexType>
          </TypeFilter>
          <Fields>
            <SearchIndexField xsi:nil="true" />
            <SearchIndexField xsi:nil="true" />
          </Fields>
          <EntityIDs>
            <int>int</int>
            <int>int</int>
          </EntityIDs>
          <DateFrom>dateTime</DateFrom>
          <DateTo>dateTime</DateTo>
        </Request>
        <Items>
          <SearchIndexResult>
            <Score>float</Score>
            <VeetroID>int</VeetroID>
            <VeetroBaseType>Entry or Notation or Message or Document or Invoice or Transaction or Entity or Lead or BlogPost or Blog or InvoiceItem or CatalogItem or Proposal or Article or Activity or CatalogItemCategory or SupportCaseType or MailQueue or Calendar or CustomView or Report or ReportWidgetCategory or Template</VeetroBaseType>
            <SearchIndexType>Any or Event or ToDo or Journal or Invoice or Project or Support_Case or Disbursement or Notation or Message or Subscription or Product or Document or Quote or Credit_Invoice or IM or Withdrawal or Deposit or Refund or Person or Company or Employee or Lead or BlogPost or CatalogItem or Proposal or Article or Workgroup or Discussion</SearchIndexType>
            <TypeFlags>int</TypeFlags>
            <Title>string</Title>
            <AbstractHtml>string</AbstractHtml>
            <Fields xsi:nil="true" />
          </SearchIndexResult>
          <SearchIndexResult>
            <Score>float</Score>
            <VeetroID>int</VeetroID>
            <VeetroBaseType>Entry or Notation or Message or Document or Invoice or Transaction or Entity or Lead or BlogPost or Blog or InvoiceItem or CatalogItem or Proposal or Article or Activity or CatalogItemCategory or SupportCaseType or MailQueue or Calendar or CustomView or Report or ReportWidgetCategory or Template</VeetroBaseType>
            <SearchIndexType>Any or Event or ToDo or Journal or Invoice or Project or Support_Case or Disbursement or Notation or Message or Subscription or Product or Document or Quote or Credit_Invoice or IM or Withdrawal or Deposit or Refund or Person or Company or Employee or Lead or BlogPost or CatalogItem or Proposal or Article or Workgroup or Discussion</SearchIndexType>
            <TypeFlags>int</TypeFlags>
            <Title>string</Title>
            <AbstractHtml>string</AbstractHtml>
            <Fields xsi:nil="true" />
          </SearchIndexResult>
        </Items>
      </SearchResult>
    </SearchResponse>
  </soap12:Body>
</soap12:Envelope>