getAllContractPartyRoles
- Description
- This inquiry transaction returns the recorded party roles associated with a contract component, based on a filter value and inquiry level.
- Web Services
- Operation name: getAllContractPartyRoles
- Example
- Retrieve all contract party roles associated with the term rider component on Contract number 123456.
- Usage information
- The input to this transaction is the contract component ID for
the component whose party roles are being queried, as well as a party
inquiry level, and a filter. The response message contains the contract
party role object, and party objects depending on inquiry level. The
filter controls whether all active Party Role information only, all
inactive Party Role information only or all Party Role information
(both active and inactive) is returned.
This transaction supports the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- ContractComponentID
- Filter
- PartyInquiryLevel
- 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.
- Filter values
- The filter is mandatory. Valid values are:
- ACTIVE - returns only active records that match the search criteria.
- INACTIVE - returns only inactive records that match the search criteria.
- ALL - returns all records that match the search criteria.
Filter values must be provided in upper case.
- Transaction behavior
- Party Roles with an end date greater than the system date are considered to be Active. Party Roles with an end date less than or equal to the system date are deemed to be Inactive.
- Request message
- <InquiryType> getAllContractPartyRoles
<InquiryParam>
<tcrmParam name= "contractComponentId">
<tcrmParam name= "filter">
<tcrmParam name= "partyInquiryLevel">
- Response objects
- List of TCRMContractPartyRoleBObj with optional party data based on
the PartyInquiryLevel value:
- 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
- Not applicable