getFSPartyByPartyMacroRole
- Description
- This inquiry transaction retrieves Party data that is associated with a specified PartyMacroRole and contract data if the party plays a ContractPartyRole that is associated with the specified PartyMacroRole.
- Web Services
- Operation name: getFSPartyByPartyMacroRole
- Example
- Retrieve the party data and contract data for John Smith that defines his MacroRole as a Client.
- Usage information
- This transaction receives PartyId, PartyMacroRoleType, PartyInquiryLevel
and ContractInquiryLevel as input.
The PartyInquiryLevel controls the type of additional detail party data returned for the party being queried. Party data is returned if it exists, and if it is actively associated with the active PartyMacroRole of the type provided in the request.
The ContractInquiryLevel controls the type of additional detailed contract data returned if the party being queried plays a ContractPartyRole. Contract data is returned if the ContractPartyRole exists and if it is actively associated with the active PartyMacroRole of the type provided in the request.
When a party plays multiple ContractPartyRoles that are actively associated with the PartyMacroRole of the type requested, corresponding contract data is returned based on ContractInquiryLevel.
- Preconditions
- Not applicable
- Mandatory input
- PartyId
- PartyMacroRoleType
- PartyInquiryLevel
- ContractInquiryLevel
- Inquiry levels
- User-customizable party and contract inquiry levels are available
for this transaction.Note: The behavior of PartyInquiryLevel and ContractInquiryLevel are independent.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.
ContractInquiryLevel:- Level 0 - returns basic contract information, contract admin native keys, and contract alerts.
- Level 1 - returns level 0 data plus all contract spec values, contract components, contract component values, holdings, and party roles.
- Level 2 - returns level 1 data plus all contract party
role alerts, contract party role locations, contract party role situations,
contract party role identifiers, and contract party role relationships.Note: Party information within the PartyRole object is based on the PartyInquiryLevel.
- Level 3 - returns level 2 data plus all contract relationships.
- Level 4 - returns level 3 data plus all product relationships and term conditions associated with the account.
- Filter values
- Not applicable
- Transaction behavior
- PartyAlert can be associated with the PartyMacroRole, but its
details are not retrievable through this service.
When PartyAddress data is retrieved as associated actively with active PartyMacroRole, the corresponding Address data is returned as well.
When PartyContactMethod data is retrieved as associated actively with active PartyMacroRole, the corresponding ContactMethod data is returned as well.
PartyInquiryLevel supported values are: 0; 1; 2; 3; 4; or UserCustomizedPartyInquiryLevels.
ContractInquiryLevel supported values are: 0, 1; 2; 3 or UserCustomizedContractInquiryLevels.
ContractInquiryLevel should be greater than 0 to include ContractPartyRole data.
- Request message
- <InquiryType> getFSPartyByPartyMacroRole
<tcrmParam name= "partyId">
<tcrmParam name= "partyMacroRoleType">
<tcrmParam name= "partyInquiryLevel">
<tcrmParam name= "contractInquiryLevel">
- Response objects
- TCRMFSPartyBObj
- Special note
- Not applicable