getAllPartyRelationshipRoles
- Description
- This inquiry transaction returns the recorded roles associated with a specified Party Relationship and Party, based on a filter value.
- Web Services
- Operation name: getAllPartyRelationshipRoles
- Example
- Retrieve all the active Party Relationship Roles associated with Party Relationship Id = 1234 and Party = 5678.
- Usage information
- The filter value controls whether only active, only inactive or
all active and inactive Party Relationship Roles are returned.
This transaction supports the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- PartyRelationshipId
- PartyId
- Filter
- Inquiry levels
- Not applicable
- Filter values
- ACTIVE, INACTIVE, or ALL
Filter values must be provided in upper case.
- Transaction behavior
- Party Relationship Roles with an End Date less than equal with
the system date are considered inactive.
Party Relationship Roles without End Date or with End Date greater than the system date are considered active.
If the filter value is not provided or is provided but invalid, the transaction will consider the default "ALL" value and both active and inactive Party Relationship Roles are returned.
- Request message
- <InquiryType> getAllPartyRelationshipRoles
<tcrmParam name= "relationshipId">
<tcrmParam name= "partyId">
<tcrmParam name= "filter">
- Response objects
- One or many TCRMPartyRelationshipRoleBObj business objects
- Special note
- Not applicable