getAllCategoryChildren
- Description
- This inquiry transaction returns all the child categories of a given category, along with their category relationships.
- Web Services
- Operation name: getAllCategoryChildren
- Example
- Retrieve all child categories of the "Office Supplies" category.
- 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 child categories and, for each active
child, returns only active category relationships associated with
the child.Note: If the given category has a child that is active but has an inactive relationship with that child, the child category will still be returned, but the inactive relationship will not.
- INACTIVE - returns only inactive child categories and, for each inactive child, returns only inactive category relationships associated with the child.
- ALL - returns all child categories and their category relationships, both active and inactive.
Filter values are not case sensitive for this transaction.
- ACTIVE - returns only active child categories and, for each active
child, returns only active category relationships associated with
the child.
- Transaction behavior
- Category relationships associated with the given category's child
categories are also returned.
This transaction only returns the direct child categories of the given category, not all descendent categories. To retrieve all descendents of a category, use the getAllCategoryDescendents transaction.
- Request message
- <InquiryType> getAllCategoryChildren
<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