getAllGroupingsByEntityId
- Description
- This inquiry transaction returns all the Grouping and GroupingAssociation details for a given EntityId, based on the inquiry level and filters.
- Web Services
- Operation name: getAllGroupingsByEntityId
- Example
- Retrieve the details of the Groupings for CampaignId 123, such as "Marketing" and "Consumer Loyalty".
- Usage information
- The inquiry level controls the type and extent of information
returned for a Grouping and GroupingAssociations.
Optionally, one or more GroupingType parameters can be supplied to further filter the information returned.
This transaction does not support the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- EntityName
- EntityId
- GroupingInquiryLevel
- GroupingFilter
- GroupingAssociationFilter
- Inquiry levels
- GroupingInquiryLevel:
- Level 0 - returns Grouping details.
- Level 1 - returns level 0 data plus GroupingAssociation details.
- Filter values
- This transaction supports filters. Valid values are:
- ACTIVE - returns only active records.
- INACTIVE - returns only inactive records.
- ALL - returns all records, both active and inactive.
The GroupingFilter applies to the Grouping level.
The GroupingAssocationFilter applies to the GroupingAssocation level.
If the filter value is not provided, or is provided but is invalid, the transaction uses the default value, ALL, and returns both active and inactive records.
The filter value is case sensitive and must be provided in upper case.
- Transaction behavior
- For GroupingInquiryLevel values other than 0 or 1, the transaction
will fail.
Optionally, this transaction can receive a list of GroupTypes that further filter the response. When the list is empty (no GroupType is provided), all GroupTypes are considered in which the given Entity is grouped.
- Request message
- <TCRMTxType> getAllGroupingsByEntityId
<TCRMTxObject> DWLGroupingRequestBObj
<TCRMObject> DWLGroupingRequestBObj
- Response objects
- DWLGroupingBObj details based on the GroupingInquiryLevel:
0 - returns DWLGroupingBObj
1 - returns level 0 plus DWLGroupingAssociationBObj
- Special note
- Not applicable