Finder Web Service

Finder

Click here for a complete list of operations.

Search

Searches for different types of data based on the given finder type and search pattern.

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 /webservices/finder.asmx HTTP/1.1
Host: accounting2.twinfield.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.twinfield.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:Header>
    <Header xmlns="http://www.twinfield.com/">
      <SessionID>string</SessionID>
      <AccessToken>string</AccessToken>
      <CompanyCode>string</CompanyCode>
      <CompanyId>guid</CompanyId>
    </Header>
  </soap:Header>
  <soap:Body>
    <Search xmlns="http://www.twinfield.com/">
      <type>string</type>
      <pattern>string</pattern>
      <field>int</field>
      <firstRow>int</firstRow>
      <maxRows>int</maxRows>
      <options>
        <ArrayOfString>
          <string>string</string>
          <string>string</string>
        </ArrayOfString>
        <ArrayOfString>
          <string>string</string>
          <string>string</string>
        </ArrayOfString>
      </options>
    </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://www.twinfield.com/">
      <SearchResult>
        <MessageOfErrorCodes>
          <Type>Error or Warning or Informational</Type>
          <Text>string</Text>
          <Code>NoAccessToOffice or OptionNotAllowed or InvalidBooleanOptionValue or InvalidIntegerOptionValue or InvalidDecimalOptionValue or InvalidEnumerationOptionValue or OptionValueOutOfRange or ParameterOutOfRange or InvalidFinderType or ParameterTooSmall or OptionLevelMandatoryForSectionTeq or OptionIcIncompatibleWithOptionHidden or InvalidDateTimeOptionLength or InvalidDateTimeOptionValue or InvalidDateTimeOptionOutOfRange or OptionMandatory or AccessDenied or DisableAccessRulesNotAllowed or Option1MandatoryIfOption2IsUsed</Code>
          <Parameters>
            <string>string</string>
            <string>string</string>
          </Parameters>
        </MessageOfErrorCodes>
        <MessageOfErrorCodes>
          <Type>Error or Warning or Informational</Type>
          <Text>string</Text>
          <Code>NoAccessToOffice or OptionNotAllowed or InvalidBooleanOptionValue or InvalidIntegerOptionValue or InvalidDecimalOptionValue or InvalidEnumerationOptionValue or OptionValueOutOfRange or ParameterOutOfRange or InvalidFinderType or ParameterTooSmall or OptionLevelMandatoryForSectionTeq or OptionIcIncompatibleWithOptionHidden or InvalidDateTimeOptionLength or InvalidDateTimeOptionValue or InvalidDateTimeOptionOutOfRange or OptionMandatory or AccessDenied or DisableAccessRulesNotAllowed or Option1MandatoryIfOption2IsUsed</Code>
          <Parameters>
            <string>string</string>
            <string>string</string>
          </Parameters>
        </MessageOfErrorCodes>
      </SearchResult>
      <data>
        <TotalRows>int</TotalRows>
        <Columns>
          <string>string</string>
          <string>string</string>
        </Columns>
        <Items>
          <ArrayOfString>
            <string>string</string>
            <string>string</string>
          </ArrayOfString>
          <ArrayOfString>
            <string>string</string>
            <string>string</string>
          </ArrayOfString>
        </Items>
      </data>
    </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 /webservices/finder.asmx HTTP/1.1
Host: accounting2.twinfield.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>
    <Header xmlns="http://www.twinfield.com/">
      <SessionID>string</SessionID>
      <AccessToken>string</AccessToken>
      <CompanyCode>string</CompanyCode>
      <CompanyId>guid</CompanyId>
    </Header>
  </soap12:Header>
  <soap12:Body>
    <Search xmlns="http://www.twinfield.com/">
      <type>string</type>
      <pattern>string</pattern>
      <field>int</field>
      <firstRow>int</firstRow>
      <maxRows>int</maxRows>
      <options>
        <ArrayOfString>
          <string>string</string>
          <string>string</string>
        </ArrayOfString>
        <ArrayOfString>
          <string>string</string>
          <string>string</string>
        </ArrayOfString>
      </options>
    </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://www.twinfield.com/">
      <SearchResult>
        <MessageOfErrorCodes>
          <Type>Error or Warning or Informational</Type>
          <Text>string</Text>
          <Code>NoAccessToOffice or OptionNotAllowed or InvalidBooleanOptionValue or InvalidIntegerOptionValue or InvalidDecimalOptionValue or InvalidEnumerationOptionValue or OptionValueOutOfRange or ParameterOutOfRange or InvalidFinderType or ParameterTooSmall or OptionLevelMandatoryForSectionTeq or OptionIcIncompatibleWithOptionHidden or InvalidDateTimeOptionLength or InvalidDateTimeOptionValue or InvalidDateTimeOptionOutOfRange or OptionMandatory or AccessDenied or DisableAccessRulesNotAllowed or Option1MandatoryIfOption2IsUsed</Code>
          <Parameters>
            <string>string</string>
            <string>string</string>
          </Parameters>
        </MessageOfErrorCodes>
        <MessageOfErrorCodes>
          <Type>Error or Warning or Informational</Type>
          <Text>string</Text>
          <Code>NoAccessToOffice or OptionNotAllowed or InvalidBooleanOptionValue or InvalidIntegerOptionValue or InvalidDecimalOptionValue or InvalidEnumerationOptionValue or OptionValueOutOfRange or ParameterOutOfRange or InvalidFinderType or ParameterTooSmall or OptionLevelMandatoryForSectionTeq or OptionIcIncompatibleWithOptionHidden or InvalidDateTimeOptionLength or InvalidDateTimeOptionValue or InvalidDateTimeOptionOutOfRange or OptionMandatory or AccessDenied or DisableAccessRulesNotAllowed or Option1MandatoryIfOption2IsUsed</Code>
          <Parameters>
            <string>string</string>
            <string>string</string>
          </Parameters>
        </MessageOfErrorCodes>
      </SearchResult>
      <data>
        <TotalRows>int</TotalRows>
        <Columns>
          <string>string</string>
          <string>string</string>
        </Columns>
        <Items>
          <ArrayOfString>
            <string>string</string>
            <string>string</string>
          </ArrayOfString>
          <ArrayOfString>
            <string>string</string>
            <string>string</string>
          </ArrayOfString>
        </Items>
      </data>
    </SearchResponse>
  </soap12:Body>
</soap12:Envelope>