WebSearch Web Service

WebSearch

Click here for a complete list of operations.

ExecuteSearch

This method will return an Xmlelement with the results from the search that was provided

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 /services/wse/WebSearch.asmx HTTP/1.1
Host: px-demo.avcm.esvccenter.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://harlandfs/ECM/Services/Search/ExecuteSearch"

<?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>
    <AuthTicket xmlns="http://harlandfs/ECM/Services/Search/">
      <AuthenticatedTicket>string</AuthenticatedTicket>
    </AuthTicket>
  </soap:Header>
  <soap:Body>
    <ExecuteSearch xmlns="http://harlandfs/ECM/Services/Search/">
      <SearchRequest>
        <Description>string</Description>
        <Top>int</Top>
        <Type>Customer or Document or Statement or Item or Report or Receipt or StatementItem or Account or Terminology or Calendar or Transaction or Batch or AllContent or ChangeDetail or Audit or ItemIrdPrintHistory or ItemHistory or File or TrackedDocument</Type>
        <Columns>
          <SearchColumn>
            <Index>int</Index>
            <TermName>string</TermName>
            <Description>string</Description>
            <ColumnTermType>String or Date or DateTime or Number or Boolean or Money</ColumnTermType>
            <ColumnDisplayFormat>C or D or A or N or P or S or T</ColumnDisplayFormat>
            <DecimalPlaces>int</DecimalPlaces>
            <CustomFormatterName>string</CustomFormatterName>
          </SearchColumn>
          <SearchColumn>
            <Index>int</Index>
            <TermName>string</TermName>
            <Description>string</Description>
            <ColumnTermType>String or Date or DateTime or Number or Boolean or Money</ColumnTermType>
            <ColumnDisplayFormat>C or D or A or N or P or S or T</ColumnDisplayFormat>
            <DecimalPlaces>int</DecimalPlaces>
            <CustomFormatterName>string</CustomFormatterName>
          </SearchColumn>
        </Columns>
        <Filter>
          <Operator>string</Operator>
          <Expressions>
            <Expression xsi:nil="true" />
            <Expression xsi:nil="true" />
          </Expressions>
        </Filter>
        <SearchOrderTerms>
          <OrderTerm>
            <IsDescending>boolean</IsDescending>
          </OrderTerm>
          <OrderTerm>
            <IsDescending>boolean</IsDescending>
          </OrderTerm>
        </SearchOrderTerms>
        <LeafObject>
          <Term>string</Term>
          <Condition>string</Condition>
          <Argument1>string</Argument1>
          <Argument2>string</Argument2>
        </LeafObject>
      </SearchRequest>
    </ExecuteSearch>
  </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>
    <ExecuteSearchResponse xmlns="http://harlandfs/ECM/Services/Search/">
      <ExecuteSearchResult>xml</ExecuteSearchResult>
    </ExecuteSearchResponse>
  </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 /services/wse/WebSearch.asmx HTTP/1.1
Host: px-demo.avcm.esvccenter.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:Header>
    <AuthTicket xmlns="http://harlandfs/ECM/Services/Search/">
      <AuthenticatedTicket>string</AuthenticatedTicket>
    </AuthTicket>
  </soap12:Header>
  <soap12:Body>
    <ExecuteSearch xmlns="http://harlandfs/ECM/Services/Search/">
      <SearchRequest>
        <Description>string</Description>
        <Top>int</Top>
        <Type>Customer or Document or Statement or Item or Report or Receipt or StatementItem or Account or Terminology or Calendar or Transaction or Batch or AllContent or ChangeDetail or Audit or ItemIrdPrintHistory or ItemHistory or File or TrackedDocument</Type>
        <Columns>
          <SearchColumn>
            <Index>int</Index>
            <TermName>string</TermName>
            <Description>string</Description>
            <ColumnTermType>String or Date or DateTime or Number or Boolean or Money</ColumnTermType>
            <ColumnDisplayFormat>C or D or A or N or P or S or T</ColumnDisplayFormat>
            <DecimalPlaces>int</DecimalPlaces>
            <CustomFormatterName>string</CustomFormatterName>
          </SearchColumn>
          <SearchColumn>
            <Index>int</Index>
            <TermName>string</TermName>
            <Description>string</Description>
            <ColumnTermType>String or Date or DateTime or Number or Boolean or Money</ColumnTermType>
            <ColumnDisplayFormat>C or D or A or N or P or S or T</ColumnDisplayFormat>
            <DecimalPlaces>int</DecimalPlaces>
            <CustomFormatterName>string</CustomFormatterName>
          </SearchColumn>
        </Columns>
        <Filter>
          <Operator>string</Operator>
          <Expressions>
            <Expression xsi:nil="true" />
            <Expression xsi:nil="true" />
          </Expressions>
        </Filter>
        <SearchOrderTerms>
          <OrderTerm>
            <IsDescending>boolean</IsDescending>
          </OrderTerm>
          <OrderTerm>
            <IsDescending>boolean</IsDescending>
          </OrderTerm>
        </SearchOrderTerms>
        <LeafObject>
          <Term>string</Term>
          <Condition>string</Condition>
          <Argument1>string</Argument1>
          <Argument2>string</Argument2>
        </LeafObject>
      </SearchRequest>
    </ExecuteSearch>
  </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>
    <ExecuteSearchResponse xmlns="http://harlandfs/ECM/Services/Search/">
      <ExecuteSearchResult>xml</ExecuteSearchResult>
    </ExecuteSearchResponse>
  </soap12:Body>
</soap12:Envelope>