getCategory
- Description
- This inquiry transaction returns all details recorded for a given category.
- Web Services
- Operation name: getCategory
- Example
- Retrieve the details of the Life Insurance category and its parent and child category relationships with other categories.
- Usage information
- Depending on the inquiry level provided, this transaction returns
category and category relationship details.
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.
- Preconditions
- Not applicable
- Mandatory input
- CategoryId
- InquiryLevel
- Filter
- Inquiry levels
- InquiryLevel:
- Level 0 - returns Category details plus category entity spec uses.
- Level 1 - returns level 0 data plus Category Relationship details.
- Filter values
- The filter is mandatory. Valid values are:
- ACTIVE - returns only active category relationships for InquiryLevel 1.
- INACTIVE - returns only inactive category relationships for InquiryLevel 1.
- ALL - returns all category relationships, both active and inactive, for InquiryLevel 1.
Both active and inactive category entity spec uses are returned regardless of filter value.
Filter values are not case sensitive for this transaction.
- Transaction behavior
- This transaction always returns category details, regardless the filter value.
- Request message
- <InquiryType> getCategory
<InquiryParam>
<tcrmParam name = "CategoryId">
<tcrmParam name = "InquiryLevel">
<tcrmParam name = "Filter">
- Response objects
- Category details based on the inquiry level:
- 0 - returns CategoryBObj plus CategorySpecUseBObj
- 1 - returns level 0 data plus CategoryRelationshipBObj
If the optional InquiryLanguage element is provided in the request header, the business objects for localized content are also returned:
- Special note
- Not applicable