getAllProductPartyRoles
- Description
- This transaction retrieves the details of existing product-party role records.
- Web Services
- Operation name: getAllProductPartyRoles
- Example
- Retrieve all active product-party role records for XYZ Company.
Retrieve all product-party role records for XYZ Company and the Golden Harvest Investment Plan product.
- Usage information
- This fine grained transaction can be used to retrieve a collection of product-party role records based on the filter inputs in the request.
- Preconditions
- Not applicable
- Mandatory input
- filter
- Inquiry levels
- Not applicable
- Filter values
- This transaction supports the following filter values.
- ACTIVE – returns all active product-party role records that match the request criteria.
- INACTIVE – returns all inactive product-party role records that match the request criteria.
- ALL – returns all product-party role records that match the request criteria, regardless of whether they are active or inactive.
Filter values are case sensitive.
Any filter values other than ACTIVE, INACTIVE, or ALL will result in an error.
- Transaction behavior
- This transaction returns all product-party role records associated
with a given party, product, or both.
The following table describes the behavior of this transaction depending on which attributes are included in the request.
Table 1. getAllProductPartyRoles transaction behavior Attributes included in the request Transaction behavior partyId and filter Returns product-party role records corresponding to the given party. partyId, productId, and filter Returns product-party role records corresponding to the given party and product. partyId, productPartyRoleCodeType, and filter Returns product-party role records corresponding to the given party and role type. partyId, productId, productPartyRoleCodeType, and filter Returns product-party role records corresponding to the given party, role type, and product. When the filter value is set to ACTIVE, this inquiry should return ether zero or one record. productId and filter Returns product-party role records corresponding to the given product. productId, productPartyRoleCodeType, and filter Returns product-party role records corresponding to the given product and role type. productPartyRoleCodeType and filter Returns product-party role records corresponding to the given role type. adminClientId, adminSysCodeType, and filter Returns product-party role records corresponding to the given adminClientId and adminSysCodeType. adminClientId, adminSysCodeType, productId, and filter Returns product-party role records corresponding to the given adminClientId, and adminSysCodeType, and product. adminClientId, adminSysCodeType, productPartyRoleCodeType, and filter Returns product-party role records corresponding to the given adminClientId, adminSysCodeType, and role type. adminClientId, adminSysCodeType, productId, productPartyRoleCodeType, and filter Returns product-party role records corresponding to the given adminClientId, adminSysCodeType, product, and role type. adminProductId, adminSysCodeType, and filter Returns product-party role records corresponding to the given adminProductId and adminSysCodeType. adminProductId, adminSysCodeType, partyId, and filter Returns product-party role records corresponding to the given adminProductId, adminSysCodeType, and party. adminProductId, adminSysCodeType, productPartyRoleCodeType, and filter Returns product-party role records corresponding to the given adminProductId, adminSysCodeType, and role type. adminProductId, adminSysCodeType, partyId, productPartyRoleCodeType, and filter Returns product-party role records corresponding to the given adminProductId, adminSysCodeType, party, and role type.When the filter value is set to ACTIVE, this inquiry should return ether zero or one record. filter Returns all product-party role records available in the table, filtered based on the filter value. Any combination of inputs other than those described in the table will result in an error.
The filter is always a mandatory input. Any request that does not include a filter value will result in an error.
- Request message
- <TCRMTxType> getAllProductPartyRoles
<TCRMTxObject> TCRMProductPartyRoleBObj
<TCRMObject> ProductPartyRoleBObj
- Response objects
- List of ProductPartyRoleBObj business objects
- Special note
- Not applicable