getParty

Description
This inquiry transaction returns detail information for a given party. Note: This transaction can also be used in a hybrid MDM implementation to retrieve the configured composite view of the party from virtual MDM if only cross-reference keys of the entity are persisted in physical MDM.
Web Services
Operation name: getParty
Service name: PartyService
Example
Retrieve details for the Person party Kim Carrol.
Retrieve the configured composite view of the entity from virtual MDM because only the cross-reference keys for the entity have been persisted in a hybrid MDM implementation.
Retrieve the persisted view of the entity from physical MDM because the entity has been fully persisted in a hybrid MDM implementation.
Usage information
The input for this transaction is the PartyId of the party being queried, the PartyType, and an inquiry level. For PartyType, you can provide an empty tag or a valid value of "O" (for Organization) or "P" (for Person). The PartyType values are not case sensitive.

The inquiry level controls the different types of additional details that are returned for the party being queried.

Preconditions
Not applicable
Mandatory input
  • PartyId
  • PartyType
  • InquiryLevel
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.
Note: The default inquiry levels are configured for use with physical MDM and are based on the data model for physical MDM. For hybrid MDM implementations, rather than using the default inquiry levels, consider creating custom inquiry levels that account for how the person or organization entities are defined within the shared virtual MDM and physical MDM data models.
Filter values
Not applicable
Transaction behavior

The retrieval of the AccessDateValue business object as part of this transaction is dependent on the properties value global flag "attrib_access_date_value". If this flag is set to ON, then this transaction always brings back the AccessDateValue business object at the attribute level.

Note: If you have implemented a hybrid MDM solution, the transaction uses both entity link status and entity status to determine whether to retrieve the party details from physical MDM or from virtual MDM. If the entity is fully persisted, then the persisted party in physical MDM is returned. If only the cross-reference keys of the entity are persisted (entity registration), or if the entity status indicates that the last update of a fully persisted entity has failed, then the configured composite view of the entity from virtual MDM is returned. Supplemental attributes added to the entity in physical MDM are also returned if the attributes are included in the inquiry level specified.
Table 1. Summary of where Party details are retrieved from in a Hybrid MDM solution
Entity Link Status: Entity Status: Party details are retrieved from:
1 (entity registration) <null> Virtual MDM
1 (entity registration) 1 (Persisted entity is up-to-date) Virtual MDM
1 (entity registration) 2 (Last entity update from virtual MDM failed) Virtual MDM
2 (full persistence) <null> Physical MDM
2 (full persistence) 1 (Persisted entity is up-to-date) or <null> Physical MDM
2 (full persistence) 2 (Last entity update from virtual MDM failed) Virtual MDM
Request message
<InquiryType> getParty

<InquiryParam>

     <tcrmParam name= "PartyId">

     <tcrmParam name= "PartyType">

     <tcrmParam name= "InquiryLevel">

Response objects
Party details, depending on the value of the InquiryLevel:
Special note
In a hybrid MDM implementation, if InquireAsOfDate is provided in the request for a historical inquiry, then any historical records returned by the transaction apply only to the party records persisted in physical MDM.