The srd.wsdl file contains the SRDWebService methods that are used
to communicate with IBM Relationship Resolution Web services. SRDWebService
includes three methods: one for loading data into the entity database, one
for performing a search to query the entity database, and one for processing
any pipeline functionality available through UMF.
- loadRecord method
LoadResult loadRecord(String umfEntity)
- The LoadResult object returned from the loadRecord() method contains two
members:
Member |
Description |
Type |
entityID |
ID of the returned entity |
Long |
merged |
Flag indicating if the entity was resolved into an existing
entity or was a new entity |
Boolean |
- The umfEntity parameter is an XML string in UMF representing the data
for a single entity. Use the UMF specification for instructions on how to
properly construct a UMF_ENTITY record, making sure to define the appropriate
values for DSRC_ACCT and DSRC_REF.
- While the load method enables you to process UMF_ENTITY documents, it
does not return the raw UMF output document as a result. Instead, it returns
a LoadResult object containing the entity ID, and a flag indicating if this
was a new entity or if it was resolved with an existing one. You can use the
process method in place of the load method, if you do not mind parsing the
UMF output document. The load method simply saves you the work of parsing
the resultant UMF output document from the load operation.
- basicQuery() method
String basicQuery(String umfSearch)
- The input string to the basicQuery() method must be in the form of a UMF_SEARCH
record. The XML string returned from basicQuery() contains the UMF_SEARCH_RESULT
from the query.
- There are two types of built-in queries: Summary result-set queries and
Detail drill-down queries.
Note: This method exists only for backwards compatibility. In this release,
the method functions identical to the process method. Use the process method
in place of the basicQuery() method for all new client applications.
- score() method
String score(String scoreDefinition)
- The input string to the score() method must be in the form of a DSE_REQUEST
record. The XML string returned from the score() method contains the DSE_RESPONSE
from the score request.
Note: This method exists only for backwards compatibility. In this release,
the method functions identical to the process method. Use the process method
in place of the score() method for all new client applications.
- process method
String process(String umfRequestDocument)
- Use the process method to process any UMF input document and receive a
UMF output document as a result. The process method is intended to handle
all requests and responses supported by the pipeline and should be the method
of choice for all operations.
- This method takes a String parameter and returns a String result.