getAllSuspectsForParty
- Description
- This inquiry transaction returns all the recorded Suspect parties associated with a specific party based on a filter value. This transaction also returns all the suspect augmentation records for each suspect party, based on the suspect inquiry level.
- Web Services
- Operation name: getAllSuspectsForParty
- Example
- Retrieve party details for all parties on the database that are suspected to be the same party as John Smith.
- Usage information
- The filter controls the Suspects that are returned based on the
suspect status. The Suspect Status is user definable via a code table.
If a suspect status code table type and value were 1 (Parties
possibly duplicate), for example, and the filter were set to
1 in the transaction, then this transaction would return only those
parties that are suspects to the input party where the suspect status
is Parties possibly duplicate.
The party inquiry level controls the type and extent of additional detail information returned for each suspect party.
The suspect inquiry level controls whether suspect augmentation records are returned for each suspect party.
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
The response from this transaction returns the records for suspect parties associated with a specific party, based on a filter value.
The response also returns all of the suspect augmentation records for a specific party, depending on the suspect inquiry level.
- Request message
- <InquiryType> getAllSuspectsForParty
<InquiryParam>
<tcrmParam name= "partyId">
<tcrmParam name= "filter">
<tcrmParam name= "suspectPartyInquiryLevel">
<tcrmParam name= "suspectInquiryLevel">
- Response objects
- List of TCRMSuspectBObj business
objects with associated business objects, with details based on the
value of the SuspectPartyInquiryLevel:
- 0 includes:
- 1 includes level 0 plus:
- TCRMPartyAddressBObj list, each with associated TCRMAddressBObj
- TCRMPartyContactMethodBObj list, each with associated TCRMContactMethodBObj
- 2 returns level 1 plus TCRMPartyRelationshipBObj list, each with associated TCRMPartyBObj
- 3 includes level 2 plus:
- TCRMPartyBankAccountBObj list
- TCRMPartyChargeCardBObj list
- TCRMIncomeSourceBObj list
- 4 includes level 3 plus TCRMPartyValueBObj
Suspect augmentation details are provided based on the value of the SuspectInquiryLevel.
- Special note
- Not applicable