searchSuspectOrganizations
- Description
- This transaction searches for active organization-type parties with associated suspect records that match a given a set of search criteria, based on an inquiry level.
- Web Services
- Operation name: searchSuspectOrganizations
- Example
- Usage 1
- The Data Steward is responsible for resolving suspected duplicate relationships for organization type suspects that reside in the province of Ontario.
- Usage 2
- The Data Steward is responsible for resolving suspected duplicate relationships for those organization type suspects that were last modified on a specific date or within a date range.
- Usage 3
- The Data Steward is responsible for resolving suspected duplicate organization-type relationships for those suspects that are A2 suspect types.
- Usage 4
- The Data Steward is responsible for resolving organization-type suspects whose names start with the letter A.
- Usage information
- The search criteria supplied controls the list of suspects that are returned.
This transaction returns the list of organization type parties with their associated suspects. In addition, the suspect search can be refined by supplying one or more of the following search parameters:
- Suspect Value
- Refine your search by suspect value using the SuspectValue parameter. SuspectValue is user definable using a code table. For example, if an entry in the SuspectValue code table value is A1 then, if the SuspectValue search parameter is set to A1, this transaction returns only those suspect parties that have A1 suspects.
- Name
- The Name filter controls the list of suspects that are returned based on the suspect's
organization name. For example, retrieve organization suspects whose name is Example Corporation.
The Name filter supports wildcard and look-alike characters:
- The wildcard character is a percent sign (%). For example, to retrieve suspects whose name
starts with the letters 'EXA' as in Example, set the name filter to 'EXA%'. To retrieve suspects
whose name ends with the letter 'TH' as in Smith, set the name filter to '%TH'. To retrieve suspects
whose organization name starts with the letter 'TH' and ends with 'AS' as in Thomas, set the name
filter to 'TH%AS'. To retrieve suspects whose name contains the letters 'OO' as in Woods, set the
name filter to '%OO%'.Restriction: Wildcard characters generally cannot be used in numeric or timestamp fields.
- The look-alike character is a question mark (?). Use the look-alike character to perform searches using partial search criteria. Look-alike searches can be executed by entering one or more question mark signs anywhere within the search criteria. For example, a last name search for "Sm?th" returns all parties where the last name is Smith, Smath, Smuth, Smoth, and others. Look-alikes can be used anywhere within a field, in the beginning, end or middle. For example, "?mith", "smit?" and "sm?th" are all supported.
The name search parameter is available when the search is for person or organization type suspects.
- The wildcard character is a percent sign (%). For example, to retrieve suspects whose name
starts with the letters 'EXA' as in Example, set the name filter to 'EXA%'. To retrieve suspects
whose name ends with the letter 'TH' as in Smith, set the name filter to '%TH'. To retrieve suspects
whose organization name starts with the letter 'TH' and ends with 'AS' as in Thomas, set the name
filter to 'TH%AS'. To retrieve suspects whose name contains the letters 'OO' as in Woods, set the
name filter to '%OO%'.
- City
- The search parameter City controls the list of suspects that are returned based on the City attribute of any party address associated with the suspect. This parameter supports multiple wildcard and look-alike characters.
- Province/State Type
- The search parameter ProvinceStateType controls the list of suspects that are returned based on the state or province of any party address associated with the suspect. For example, if the State/Province code table type is 1 and value is California then, if the ProvinceStateType search parameter is set to 1 California, this transaction returns only those suspect parties with addresses in the state of California.
- Province/State Value
- The search parameter ProvinceStateValue controls the list of suspects that are returned based on the state or province of any party address associated with the suspect. For example, if the State/Province code table type is 1 and value is California then, if the ProvinceStateValue search parameter is set to California, this transaction returns only those suspect parties with addresses in the state of California.
- Client Importance Type
- The search parameter ClientImportanceType controls the list of suspects that are returned based on the client importance type. ClientImportanceType is user definable using a code table. For example, if an entry in the client importance code table type is 2 and value is High then, if the ClientImportanceType search parameter is also set to 2, this transaction returns only those suspect parties that have level 2 (High) client importance.
- Client Importance Value
- The search parameter ClientImportanceValue controls the list of suspects that are returned based on the client importance value. ClientImportanceValue is user definable using a code table. For example, if an entry in the client importance code table value is High and type is 2 then, if the ClientImportanceValue search parameter is set to High, this transaction returns only those suspect parties that have High client importance.
- Client Potential Type
- The search parameter ClientPotentialType controls the list of suspects that are returned based on the client potential type. ClientPotentialType is user definable using a code table. For example, if an entry in the client potential code table type is 2 and value is Suspect then, if the ClientPotentialType search parameter is set to 1, this transaction returns only those suspect parties that have Suspect client potential type.
- Client Potential Value
- The search parameter ClientPotentialValue controls the list of suspects that are returned based on the client potential value. ClientPotentialValue is user definable using a code table. For example, if an entry in the client potential code table value is Suspect and type is 2 then, if the ClientPotentialValue search parameter is set to Suspect, this transaction returns only those suspect parties that have Suspect client potential value.
This transaction supports the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- PartyInquiryLevel
- SuspectPartyInquiryLevel
- MaxRows
- Inquiry levels
- PartyInquiryLevel:
- Level 0 - returns Party data including names, identifications, party privacy preferences, line of business relationships, and either personal data, if a Person, or organizational data, if an Organization.
- Level 1 - returns level 0 data plus all party addresses and contact methods.
- Level 2 - returns level 1 data plus all party relationship data.
- Level 3 - returns level 2 data plus all party bank account, party charge card, and income source data.
- Level 4 - returns level 3 data plus all party value data.
SuspectPartyInquiryLevel:- Level 0 - returns suspect Party data including names, identifications, privacy preferences, line of business relationships, and either personal data, if a Person, or organizational data, if an Organization.
- Level 1 - returns level 0 data plus all party addresses and contact methods.
- Level 2 - returns level 1 data plus all party relationship data.
- Level 3 - returns level 2 data plus all party bank account, party charge card, and income source data.
- Level 4 - returns level 3 data plus all party value data.
- Filter values
- Not applicable
- Transaction behavior
- The search results are sorted first by primary key, and then by
match relevancy scores.
If more than one search parameter is provided, the response is successful if an exact match is realized on all filters provided.
The maximum number of organization parties, excluding their suspects, returned in the transaction response is configurable in the Configuration and Management component. It is also possible to set the maximum number of organization parties returned within the transaction itself; however, if this number is higher than that set in the Configuration and Management component, the number of organization parties returned in the response is set to the Configuration and Management component limit.
If the maximum set in the transaction itself is 10, then only 10 organization parties is returned. If the maximum set in the transaction itself is 150, then only 100 organization parties (the Configuration and Management component limit) are returned. Note that this maximum does not apply to the list of associated suspects for each organization party; all suspects associated with each organization party is returned, regardless of the number of suspects or the value of the maximum.
- Request message
- <TCRMTxType> searchSuspectOrganizations
<TCRMTxObject> TCRMSuspectOrganizationSearchBObj
- Response objects
- List of TCRMSuspectBObj business objects
- Special note
- Not applicable