Get category with children catalog entries
This service request, getCategoryWithChildrenCatalogEntries, returns all the child catalog entries and the displays details of a category. The catalog group ID is used in the request.
Request
Request BOD GetCatalogGroup Schema /Catalog-DataObjects/xsd/OAGIS/9.0/Overlays/IBM/Commerce/BODs/GetCatalogGroup.xsd Access profile WC_CatalogGroupCatalogEntryChildrenProfile Service data object GetCatalogGroupType
Sample request BOD
<_cat:GetCatalogGroup xmlns:_cat="http://www.ibm.com/xmlns/prod/commerce/9/catalog" xmlns:_wcf="http://www.ibm.com/xmlns/prod/commerce/9/foundation" xmlns:oa="http://www.openapplications.org/oagis/9" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <oa:ApplicationArea xsi:type="_wcf:ApplicationAreaType"> <oa:CreationDateTime> 2007-01-25T14:41:58.539Z </oa:CreationDateTime> <oa:BODID>1e4a4da0-acac-11db-a255-832d45b90806</oa:BODID> <_wcf:BusinessContext> <_wcf:ContextData name="storeId">10001</_wcf:ContextData> <_wcf:ContextData name="catalogId">10001</_wcf:ContextData> </_wcf:BusinessContext> </oa:ApplicationArea> <_cat:DataArea> <oa:Get> <oa:Expression expressionLanguage="wcf:XPath"> {_wcf.ap=WC_CatalogGroupCatalogEntryChildrenProfile}/CatalogGroup[CatalogGroupIdentifier[UniqueID='10008']] </oa:Expression> </oa:Get> </_cat:DataArea> </_cat:GetCatalogGroup>
Response
Response BOD ShowCatalogGroup Schema /Catalog-DataObjects/xsd/OAGIS/9.0/Overlays/IBM/Commerce/BODs/ShowCatalogGroup.xsd Service data object ShowCatalogGroupType The response contains the following information:
/CatalogGroup/CatalogGroupIdentifier/UniqueID /CatalogGroup/CatalogGroupIdentifier/ExternalIdentifier/@ownerID /CatalogGroup/CatalogGroupIdentifier/ExternalIdentifier/GroupIdentifier /CatalogGroup/Description/@language /CatalogGroup/Description/Name /CatalogGroup/Description/ThumbNail /CatalogGroup/Description/ShortDescription /CatalogGroup/Description/FullImage /CatalogGroup/Description/LongDescription /CatalogGroup/NavigationRelationship/@displaySequence /CatalogGroup/NavigationRelationship/CatalogEntryReference/@catalogEntryTypeCode /CatalogGroup/NavigationRelationship/CatalogEntryReference/displayName /CatalogGroup/NavigationRelationship/CatalogEntryReference/CatalogEntryIdentifier/UniqueID /CatalogGroup/NavigationRelationship/CatalogEntryReference/CatalogEntryIdentifier/ExternalIdentifier/@ownerID /CatalogGroup/NavigationRelationship/CatalogEntryReference/CatalogEntryIdentifier/ExternalIdentifier/PartNumber
Sample response BOD
<_cat:ShowCatalogGroup xmlns:Oagis9="http://www.openapplications.org/oagis/9" xmlns:_cat="http://www.ibm.com/xmlns/prod/commerce/9/catalog" xmlns:_wcf="http://www.ibm.com/xmlns/prod/commerce/9/foundation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Oagis9:ApplicationArea xsi:type="_wcf:ApplicationAreaType"> <Oagis9:CreationDateTime> 2007-01-25T14:42:00.311Z </Oagis9:CreationDateTime> <Oagis9:BODID> 1f7d7670-acac-11db-83a9-832d45b8fe37 </Oagis9:BODID> </Oagis9:ApplicationArea> <_cat:DataArea> <Oagis9:Show recordSetCompleteIndicator="false" /> <_cat:CatalogGroup> <_cat:CatalogGroupIdentifier> <_wcf:UniqueID>10008</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:GroupIdentifier> Brake pads </_wcf:GroupIdentifier> </_wcf:ExternalIdentifier> </_cat:CatalogGroupIdentifier> <_cat:Description language="-1"> <_cat:Name>Brake pads</_cat:Name> <_cat:Thumbnail> images/brake_pad_sub_sm.jpg </_cat:Thumbnail> <_cat:FullImage> images/brake_pad_sub_150.jpg </_cat:FullImage> <_cat:ShortDescription> Brake pads </_cat:ShortDescription> <_cat:LongDescription>Brake pads</_cat:LongDescription> </_cat:Description> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10029</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000334</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Ferro Carbon Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10028</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000333</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Ferro Carbon Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10027</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000332</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Ferro Carbon Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10026</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000331</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Ferro Carbon Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10024</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000289</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Semi-metallic Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10023</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000288</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Semi-metallic Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10022</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000287</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Semi-metallic Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10021</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000286</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Semi-metallic Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Product"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10020</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000282</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Semi-metallic Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10019</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000244</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Organic Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10018</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000243</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Organic Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10017</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000242</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Organic Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10016</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000241</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Organic Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10014</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000199</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Ceramic Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10013</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000198</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Ceramic Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10012</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000197</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Ceramic Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10011</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000196</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Ceramic Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10009</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000154</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Titanium Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10008</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000153</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Titanium Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10007</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000152</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Titanium Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10006</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000151</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Titanium Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10004</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000108</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Kevlar Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10003</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000107</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Kevlar Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Item"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10002</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000106</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Kevlar Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="0.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Product"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10001</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000101</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Kevlar Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="1.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Product"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10025</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000327</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Ferro Carbon Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="1.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Product"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10005</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000147</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Titanium Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="2.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Product"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10010</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000192</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Ceramic Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> <_cat:NavigationRelationship displaySequence="3.0"> <_cat:CatalogEntryReference catalogEntryTypeCode="Product"> <_cat:CatalogEntryIdentifier> <_wcf:UniqueID>10015</_wcf:UniqueID> <_wcf:ExternalIdentifier ownerID="7000000000000000002"> <_wcf:PartNumber>A0000237</_wcf:PartNumber> </_wcf:ExternalIdentifier> </_cat:CatalogEntryIdentifier> <_cat:displayName> Organic Brake Pads </_cat:displayName> </_cat:CatalogEntryReference> </_cat:NavigationRelationship> </_cat:CatalogGroup> </_cat:DataArea> </_cat:ShowCatalogGroup>
Usage
To use this service request on a JSP page use the expression-builder, getCategoryWithChildrenCatalogEntries, and pass the catGroupId parameter.
The expression-builder maps to the following XPath expression:
{_wcf.ap=$accessProfile$}/CatalogGroup[CatalogGroupIdentifier[UniqueID='$catGroupId$']]
The default is: accessProfile=WC_CatalogGroupCatalogEntryChildrenProfile
This service request uses the
CatalogGroupDataBean data bean.
Exceptions
If there is an error the error is reported in the Response message. You can see the error details in the trace log, SystemOut.log.
Customization
The following extensions are supported:
- Create your own implementation of the interface ComposeCatalogGroupTaskCmd. By creating your own implementation of the ComposeCatalogGroupTaskCmd, and an access profile you can control the level of information returned by these services.
Related concepts
../../com.ibm.commerce.business_process.doc/concepts/processFind_product_(ConsumerDirect).htm
Design pattern for Get service implementation
Related Reference
WebSphere Commerce foundation tag library