getCategoryRelationship
- Description
- This inquiry transaction returns one or more active category relationships between two categories within a category hierarchy, based on the unique identifiers (CategoryIds) of the parent and child categories.
- Web Services
- Operation name: getCategoryRelationship
- Example
- Retrieve the category relationship between the parent category "Investments" and the child category "Mutual Funds".
- Usage information
- Because there can be more than one active category relationship
between two categories, provided their effective dates do not overlap,
this transaction can return more than one active category relationship.
This transaction returns only category relationships that are active. To retrieve inactive relationships, use the transaction getAllCategoryRelationships.
- Preconditions
- Not applicable
- Mandatory input
- ParentCategoryId
- ChildCategoryId
- Inquiry levels
- Not applicable
- Filter values
- Not applicable
- Transaction behavior
- This transaction returns only active category relationships.
If all relationships between the parent category and child category are inactive, then this transaction does not return a record.
- Request message
- <InquiryType> getCategoryRelationship
<InquiryParam>
<tcrmParam name = "ParentCategoryId">
<tcrmParam name = "ChildCategoryId">
- Response objects
- One or more CategoryRelationshipBObj objects
- Special note
- Not applicable