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
Service name: PartyService
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 Type
The search parameter suspect type controls the list of suspects that are returned based on the suspect type. The Suspect Type is user definable via a code table. For example, if an entry in the suspect type code table type and value were 1 and A1, then if the suspect type search parameter was set to 1 and A1, then this transaction returns only those suspect parties that have A1 suspects. The A1 suspects and all other suspects for those parties would be returned, including those suspects that do not meet the suspect type search criteria.
State/Province
The search parameter State/Province controls the list of suspects that are returned based on the address province of any party address associated with the suspect. For example, State/Province code table type and value were 1 and California, then, if the State/Province search parameter was set to 1 and California, then this transaction would return only those suspect parties whose address is located in the state of California.
SuspectLastUpdateDate or Date Range
The search parameter Suspect Modified Start and End dates controls the list of suspects that are returned based on the suspect last update date. For example, if the Suspect Modified Start Date is set to the current date and the Suspect Modified End Date is not provided, then this transaction would return only those parties that were last updated on the Suspect Modified Start Date provided. Alternatively, if both the Suspect Modified Start and End Dates are provided, then this transaction would return all suspects that were last updated from the Suspect Modified Start Date up to but not including the Suspect Modified End Date.
Name
The filter 'Name' controls the list of suspects that are returned based on the suspect last name or organization name. For example, to retrieve organization suspects whose name are 'Smith'. Wildcard (percent sign (%)) can be used only when using the Name filter. For example, to retrieve suspects whose name starts with the letter 'ADA' as in Adams, set the name filter to 'ADA%' 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%'.

The name search parameter is only available when the search is for either person or organization-type suspects.

Restriction: Wildcard characters generally cannot be used in numeric or timestamp fields.

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


Last updated: 5 Jun 2018