getAllCategoryParents
- Description
- This inquiry transaction returns all the parent categories of a given category, along with their category relationships.
- Web Services
- Operation name: getAllCategoryParents
- Example
- Retrieve all parent categories of the "Mutual Funds" category in the product hierarchy of a financial services organization.
- Usage information
- This transaction can also return localized content. The request
header (DWLControl element) contains the localization parameter, InquiryLanguage.
The values for InquiryLanguage must correspond to either LanguageType
or Locale, as defined in the CDLANGTP code table. Each request can
include one or more InquiryLanguage elements, enabling you to retrieve
localized content for all desired locales.
This transaction supports the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- CategoryId
- Filter
- Inquiry levels
- Not applicable
- Filter values
- Filter values are mandatory for this transaction. Valid values
are:
- ACTIVE - returns only active parent categories and, for each active
parent, returns only active category relationships associated with
the parent.Note: If the given category has a parent that is active but has an inactive relationship with that parent, the parent category will still be returned, but the inactive relationship will not.
- INACTIVE - returns only inactive parent categories and, for each inactive parent, returns only inactive category relationships associated with the parent.
- ALL - returns all parent categories and their category relationships, both active and inactive.
Filter values are not case sensitive for this transaction.
- ACTIVE - returns only active parent categories and, for each active
parent, returns only active category relationships associated with
the parent.
- Transaction behavior
- Category relationships associated with the given category's parent
categories are also returned.
This transaction only returns the direct parent categories of the given category, not all ancestor categories. To retrieve all ancestors of a category, use the getAllCategoryAncestors transaction.
- Request message
- <InquiryType> getAllCategoryParents
<InquiryParam>
<tcrmParam name = "CategoryId">
<tcrmParam name = "Filter">
- Response objects
- CategoryBObj and CategoryRelationshipBObjIf the optional InquiryLanguage element is provided in the request header, the business objects for localized content are also returned:
- Special note
- Not applicable