Formatting Requests - trillium_quality - 17.1

Trillium TS Web Services Developer Guide

Product type
Software
Product family
Trillium
Product
Trillium > Trillium Quality
Version
17.1
Language
English
Product name
Trillium Quality
Title
Trillium TS Web Services Developer Guide
Topic type
Overview
Administration
Configuration
Installation
Reference
How Do I
First publish date
2008

The format of your REST/SOAP request is determined by the TS Web Services WSDL, described in TS Web Service with TSI - WSDL. The available operations for TS Web Services with TSI are:

ActiveProjects

WebKeyStatistics

Ping

CleanseUnicode

WindowMatchUnicode

ReferenceMatchUnicode

CleanseInputFields

CleanseOutputFields

CleanseAllOutputFields

MatchInputFields

MatchOutputFields

MatchAllOutputFields

To format your requests, you can use the SOAP stub created by the Web Service Manager as a template, as described in Using the Sample Request as a Template. When formatting requests:

  • Ensure that the address in your request is correctly formed. For example:

http://localhost:8484/TrilliumSOAP/services/TrilliumSOAP.TrilliumSOAPHttpSoap11Endpoint/

  • If any web keys have been configured, the request must include a valid <webKey> element. If no keys are defined, requests do not require a key and any <webKey> value passed in the SOAP request, including null or ?, is ignored.

  • The request must include the name of a running project. (See Configuring and Starting a Project for information on starting a project.)

  • For a ReferenceMatchUnicode request, use the nameForm and matchLevel parameters to specify the type of match to be performed.

<soap:nameForm>1</soap:nameForm> <soap:matchLevel>1</soap:matchLevel>

  • Set nameForm to 1 to use consumer matching rules; set to 2 to use business matching rules. If left blank, the default is 2.

  • Set matchLevel to 1, 2, 3 or 4.

    • For consumer matches, match level 1 includes household level matches; match level 2 includes individual level matches; match level 3 includes match suspects at the household level; match level 4 includes match suspects at the individual level.

    • For business matches, match level 1 includes company level matches; match level 2 includes contact level matches; match level 3 includes match suspects at the company level; match level 4 included match suspects at the contact level.
    The default name form and match level is 1. The sample project, DIRPROJ, is designed for match level 1.
  • In ReferenceMatchUnicode requests, the 64-bit implementation supports specifying a unique record identifier using the <xsd:userKey>value</xsd:userKey> statement. See Populating the Matcher_User_Key for information on this option.