getAllPartySuspects
- Description
- This inquiry transaction returns all the recorded suspect parties associated with a specific party based on an inquiry level and filter value and includes the best match designation for one of the suspects if one exists. This transaction also returns all the suspect augmentation records for each suspect party, based on the suspect inquiry level. A similar transaction, getAllSuspectsForParty, returns all the persisted suspect records of a given partyId. The getAllPartySuspects transaction, by comparison, not only does the job of getAllSuspectsForParty, but also uses the Best Match Indicator rule or Filtered Suspect Matches.
- Web Services
- Operation name: getAllPartySuspects
- Example
- The Data Steward would like to view all suspected duplicates associated with a given party.
- Usage information
- The input to this transaction is the partyId for the party for
which suspect is being queried.
This transaction supports the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- PartyId
- Filter
- SuspectPartyInquiryLevel
- SuspectInquiryLevel
- Inquiry levels
- 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.
SuspectInquiryLevel:- Level 0 - does not return any suspect augmentation information.
- Level 1 - returns all suspect augmentation details for each suspect party.
- Filter values
- suspectStatusType
- Transaction behavior
- When given the party ID, this transaction performs the following
steps:
- Read the suspect table and find all suspects of the provided party. It also returns all the suspect augmentation records for a specific suspect party, based on the suspect inquiry level.
- Set the best match suspect indicator for the best match suspect if one exists by using the 'best match' externalized rules.
- Request message
- <InquiryType> getAllPartySuspects
<InquiryParam>
<tcrmParam name= "partyId">
<tcrmParam name= "filter">
<tcrmParam name= "suspectPartyInquiryLevel">
<tcrmParam name= "suspectInquiryLevel">
- Response objects
- List of TCRMSuspectBObj business objects with associated business objects
- Special note
- Not applicable