getAllContractsByContactMethodId

Description
This inquiry transaction returns the recorded information for the accounts, agreements, or contracts for a given contact method ID based on contract and party inquiry levels as well as an inquiry mode. 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: getAllContractsByContactMethodId
Service name: FinancialServices
Example
Retrieve all contracts associated with the physical contact method 201-889-9900.
Usage information
The input to this transaction is a contact method ID for the contact method whose associated contracts are being queried, a mode, a contract inquiry level, a party inquiry level, and a filter.
The mode controls which party roles and parties are returned in the response:
  • When the mode is set to INCLUSIVE, where a contract location exists for the role and address, only those party roles, and the associated party information that uses that contact method, are returned in the response.
  • When the mode is set to EXCLUSIVE, all party role details for all party roles on contracts that include that contact method are returned in the response.

This transaction supports the Pagination feature.

Preconditions
Not applicable
Mandatory input
  • ContactMethodId
  • Filter
  • Mode
  • ContractInquiryLevel
  • PartyInquiryLevel
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.
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 active records.
  • INACTIVE - returns only inactive records.
  • ALL - returns all records, both active and inactive.

Filter values are case sensitive and must be provided in upper case.

Note: The filter value is not used directly by this transaction, but it can be used in the InfoSphere MDM extension framework.
Transaction behavior
When the contract inquiry level is 0, no party detail information is returned regardless of the party inquiry level since the contract inquiry level 0 response does not include the party role business object. For details, see the transaction getContract.
Request message
<InquiryType> getAllContractsByContactMethodId

<tcrmParam name= "contactMethodId">

<tcrmParam name= "filter">

<tcrmParam name= "mode">

<tcrmParam name= "contractInquiryLevel">

<tcrmParam name= "partyInquiryLevel">

Response objects
List of TCRMContractBObj business objects, each with detail as defined by the inquiry levels.

ContractInquiryLevel values:

PartyInquiryLevel values:

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).