getAllPartyGroupingValuesByCategory
- Description
- This inquiry transaction returns the all PartyGroupingValues recorded for a given PartyGrouping, based on a GroupingValueCategoryType and a filter value.
- Web Services
- Operation name: getAllPartyGroupingValuesByCategory
- Example
- Retrieve all the PartyGroupingValues for the Customer Loyalty category that are associated with the Smith Household. The transaction returns information such as Average Number of Products, Number of Complaints, Customer Relationship Status, and Customer Attrition Propensity Type for the Smith household.
- Usage information
- The GroupingCategoryType and Value classify the GroupingValueTypes
and are driven by code tables.
This transaction supports the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- PartyGroupingId
- PartyGroupingCategory
- Inquiry levels
- Not applicable
- Filter values
- The filter applies to PartyGroupingValues. A filter value may
be supplied. Valid values are:
- ACTIVE - returns records where the Party is active.
- INACTIVE - returns records where the Party is inactive.
- ALL - returns all records that match the search criteria, both active and inactive.
If an invalid filter value, or no filter value, is supplied, then all records matching the search criteria are returned.
Filter values are case-sensitive, and must be provided in upper case.
- Transaction behavior
- PartyGroupingValues are considered to be inactive if the end date
is less than or equal to the current system date.
PartyGroupingValues are considered to be active if the end date is greater than the current system date.
- Request message
- <InquiryType> getAllPartyGroupingValuesByCategory
<InquiryParam>
<tcrmParam name= "partyGroupingId">
<tcrmParam name= "categoryType">
<tcrmParam name= "filter">
- Response objects
- List of TCRMPartyGroupingValueBObj
- Special note
- Not applicable