getAllContractPartyRoleRelationships
- Description
- This inquiry transaction returns the recorded contract party role (role-to-role) relationships associated with a contract, based on a filter value.
- Web Services
- Operation name: getAllContractPartyRoleRelationships
- Example
- Retrieve all role relationships for a given owner role on a contract. Billy Smith is a 12 year old minor who is listed as the owner on a contract. John Smith, his uncle, is listed as the trustee on the contract. The role relationship that this transaction retrieves in this case is that of a guardian/custodian relationship between John and Billy Smith.
- Usage information
- The input to this transaction is the contract party role ID for
the contract whose party roles are being queried as well as a filter.
The filter controls whether all active Party Role Relationships only, all inactive Party Role Relationships only or all active and inactive Party Role Relationships are returned.
This transaction supports the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- Not applicable
- Inquiry levels
- Not applicable
- Filter values
- ACTIVE, INACTIVE or ALL
Filter values must be provided in upper case.
- Transaction behavior
- Party Role Relationships with an end date greater than the system date are considered to be Active. Party Role Relationships with an end date less than or equal to the system date are deemed to be Inactive.
- Request message
- <InquiryType> getAllContractPartyRoleRelationships
<tcrmParam name= "contractRoleId">
- Response objects
- List of TCRMContractPartyRoleRelationshipBObj
- Special note
- Not applicable