getComparativeMultipleParties

Description

This transaction can be used to preview details of the source and multiple suspect parties, with all child business object collections aligned based on an inquiry level and a filter value.

Web Services

Operation name: getComparativeMultipleParties

Service name: PartyService

Example

The Data Steward would like to preview the party details for a given party and its suspects before deciding to unmark the party as a suspect of the source party.

Usage information

This transaction can be used to preview the source and multiple suspect parties details with all the child object collections aligned across the multiple parties. The child objects with the same business keys appear at the same index for each party.

The inquiry level controls the type of additional detail returned for the parties being queried.

The filter controls whether suspect persons or suspect organizations are returned.

Preconditions

Given source party must exist.

Comparative parties (if provided) must exist and must be suspects of the given source party.

Mandatory input

Filter
InquiryLevel
Given source PartyId
Secondary PartyId (at least one must be provided)

Inquiry levels

InquiryLevel:

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 (no difference).
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

O (Organization) or P (Person)

Filter values must be provided in upper case

The filter value is used by getParty when calling this transaction.

Transaction behavior

The PartyIds of the source and suspect parties must be provided as well as an inquiry level and a filter value.

After being provided with the PartyIds, this transaction performs the following steps:

Returns the given party and suspect party details based on the inquiry level.
Aligns all the child object collections across the multiple parties to ensure that the child objects with the same business keys appear at the same index for each party.

Request message

<InquiryType> getComparativeMultipleParties

<tcrmParam name= "partyId1"> (of original "source" party)

<tcrmParam name= "partyIdn"> (up to n suspect parties)

Response objects

TCRMConsolidatedPartyBObj business object

Special note: Not applicable