getAllContractsByParty
- Description
- This inquiry transaction returns the information for all accounts, agreements, or contracts where the queried party has a ContractPartyRole. The information in the return is based on the contract inquiry level and party inquiry level. For the purposes of this transaction, the terms account, agreement, and contract can be used interchangeably and refer to the same business entity: a legal agreement between parties. Unless explicitly stated, each term refers to Managed Accounts and Reference Accounts.
- Web Services
- Operation name: getAllContractsByParty
- Example
- Retrieve all contracts that Mary Brown plays a role on.
- Usage information
- The input to this transaction is the PartyId for the party whose
contracts are being queried, ContractInquiryLevel, PartyInquiryLevel,
and a filter.
This transaction supports the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- ContId (PartyId)
- PartyInquiryLevel
- ContractInquiryLevel
- Filter
- Inquiry levels
- Inquiry levels control the type of additional details returned
for each contract and party returned by this transaction. The transaction
request can include up to two separate inquiry levels: a contract
inquiry level and a party inquiry level.
Party and Contract user-customizable inquiry levels are not available for this transaction.
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.
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.
- Filter values
- This transaction supports filters. Valid values are:
- ACTIVE - returns only contract details where the party has an active contract party role.
- INACTIVE - returns only contract details where the party has an inactive contract party role.
- ALL - returns all contract details, whether the party has an active or inactive party role.
Filter values are case sensitive and must be provided in upper case.
- Transaction behavior
- Contract inquiry levels support values 1, 2, 3, and 4. If the contract inquiry level is 0, an error message is returned because level 0 responses do not included the PartyRole business object. For further details, see the transaction getContract.
- Request message
- <InquiryType> getAllContractsByParty
<tcrmParam name= "contId">
<tcrmParam name= "contractInquiryLevel">
<tcrmParam name= "partyInquiryLevel">
<tcrmParam name= "filter">
- Response objects
- List of TCRMContractBObj business objects, each with detail as defined by the inquiry levels.
ContractInquiryLevel values:
- 0 - returns TCRMContractBObj, TCRMContractAlertBObj list, and TCRMAdminNativeKeyBObj list.
- 1 - returns level 0 details plus TCRMContractComponentBObj list, TCRMContractComponentValueBObj list, TCRMVehicleHoldingBObj list, TCRMPropertyHoldingBObj list, TCRMContractPartyRoleBObj list, and ContractSpecValueBObj list. Party information within the PartyRole object is based on the PartyInquiryLevel.
- 2 - returns level 1 details plus TCRMAlertBObj list, TCRMContractRoleLocationBObj list with associatedTCRMPartyAddressBObj or TCRMPartyContactMethodBObj objects, TCRMContractPartyRoleSituationBObj list, TCRMContractPartyRoleIdentifierBObj list, and TCRMContractPartyRoleRelationshipBObj list.
- 3 - returns level 2 details plus a list of TCRMContractRelationshipBObj.
- 4 - returns level 3 details plus TermConditionBObj and TCRMProductContractRelationshipBObj.
PartyInquiryLevel values:
- 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
- Special note
- For the transaction to return the Specification Value business object (ContractSpecValueBObj), set the Smart Inquiries option for this child object to Inactive (INACTIVE_IND='Y' in the EXTENSIONSET table).