getContractClaimSummary
- Description
- This inquiry transaction returns all claim details recorded for a given contract. For example, in the insurance industry, a claim is a request for payment of benefits. An automobile policy may have had multiple claims, such as a comprehensive and collision claim on an insured vehicle.
- Web Services
- Operation name: getContractClaimSummary
- Example
- Retrieve the details of all claims associated with a given automobile
policy, including:
- the details of the automobile policy.
- the party details for those parties that have a role in the automobile policy.
- the claim party roles.
- the party details for those parties that have a role in the claim.
- Usage information
- The input required for this transaction is a unique contract identifier,
a contract inquiry level, and a claim inquiry level.
The inquiry levels control the type and extent of information returned for the contract, contract party, claim, and claim party.
- Preconditions
- Not applicable
- Mandatory input
- ContractId
- ContractInquiryLevel
- ClaimInquiryLevel
- Inquiry levels
- 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.
ClaimInquiryLevel:- Level 0 - returns the Claim business object only.
- Level 1 - returns level 0 data plus Claim Contracts.
- Level 2 - returns level 1 data plus Claim Party Roles with Party Details based on the PartyInquiryLevel.
ContractPartyInquiryLevel:- Level 0 - returns Party data including names, identifications, 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.
ClaimPartyInquiryLevel:- Level 0 - returns Party data including names, identifications, 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
- Not applicable
- Transaction behavior
- The transaction returns:
- Claim information based on the inquiry level and contract.
- Contract party and claim roles details based on the inquiry levels.
- Request message
- <InquiryType> getContractClaimSummary
<InquiryParam>
<tcrmParam name= "ContractId">
<tcrmParam name= "ContractInquiryLevel">
<tcrmParam name= "ContractPartyInquiryLevel"
<tcrmParam name= "ClaimInquiryLevel">
<tcrmParam name= "ClaimPartyInquiryLevel">
- Response objects
- TCRMContractClaimSummaryBObj with:
- Contract details based on the ContractInquiryLevel value:
- 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.
- Claim details based on the ClaimInquiryLevel value:
- 0 - TCRMClaimBObj.
- 1 - Level 0 data plus TCRMClaimContractBObj.
- 2 - Level 1 data plus TCRMClaimPartyRoleBObj with Party details based on the PartyInquiryLevel.
- Contract Party details based on the ContractPartyInquiryLevel
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
- Claim Party details based on the ClaimPartyInquiryLevel 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
- Contract details based on the ContractInquiryLevel value:
- Special note
- Not applicable