getAllCategoryDescendents
- Description
- This inquiry transaction returns all descendents for a given category. A descendent is a category that is lower in the category hierarchy tree than the given category (a subcategory).
- Web Services
- Operation name: getAllCategoryDescendents
- Example
- Retrieve all descendents, including category relationship details, of the "Insurance" 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 does not support 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 descendents and, for each active
descendent, returns only active category relationships associated
with the descendent.Note: If the given category has a descendent that is active but has an inactive relationship along the category path, the descendent will still be returned, but the inactive relationship will not.
- INACTIVE - returns only inactive descendents and, for each inactive descendent, returns only inactive category relationships associated with the descendent.
- ALL - returns all descendents and their category relationships, both active and inactive.
Filter values are not case sensitive for this transaction.
- ACTIVE - returns only active descendents and, for each active
descendent, returns only active category relationships associated
with the descendent.
- Transaction behavior
- Category relationships associated with the given category's descendents are also returned.
- Request message
- <InquiryType> getAllCategoryDescendents
<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