Get catalog groups for a parent catalog group

This service request, gets the list of catalog groups which are children of a specified catalog group. The information retrieved for each catalog group is determined by the access profile.

Request

Request BOD	GetCatalogGroup business object document (BOD).
Access profile	WC_CatalogGroupSummaryProfile
Schema	/Catalog-DataObjects/xsd/OAGIS/9.0/Overlays/IBM/Commerce/BODs/GetCatalogGroup.xsd
Service data object	com.ibm.commerce.catalog.facade.datatypes.GetCatalogGroup

Sample request BOD

<soapenv:Envelope
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header>
<wsse:Security
xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
soapenv:mustUnderstand="1">
<wsse:UsernameToken>
<wsse:Username>wcsadmin</wsse:Username>
<wsse:Password
Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">wcs1admin</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<_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-04-20T15:00:48.068Z</oa:CreationDateTime>
   
<oa:BODID>732af6a0-ef71-11db-a86e-832d46290de0</oa:BODID>
    <_wcf:BusinessContext>
      <_wcf:ContextData
name="storeId">10001</_wcf:ContextData>
      <_wcf:ContextData
name="langId">-1</_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_CatalogGroupSummaryProfile}/CatalogGroup[ParentCatalogGroupIdentifier[(UniqueID='10005')]]</oa:Expression>
    </oa:Get>
  </_cat:DataArea>
</_cat:GetCatalogGroup>
</soapenv:Body>
</soapenv:Envelope>

Response

The response based on access profile WC_CatalogGroupSummaryProfile 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

Response BOD	ShowCatalogGroup
Schema	/Catalog-DataObjects/xsd/OAGIS/9.0/Overlays/IBM/Commerce/BODs/ShowCatalogGroup.xsd
Service data object	com.ibm.commerce.catalog.facade.datatypes.ShowCatalogGroup

Sample response BOD

<soapenv:Envelope
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<_cat:ShowCatalogGroup
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:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <oa:ApplicationArea xsi:type="_wcf:ApplicationAreaType">
   
<oa:CreationDateTime>2007-04-20T15:00:41.109Z</oa:CreationDateTime>
   
<oa:BODID>6ed4bbe0-ef71-11db-9a77-82704628e1b3</oa:BODID>
  </oa:ApplicationArea>
  <_cat:DataArea>
    <oa:Show recordSetCompleteIndicator="false"/>
    <_cat:CatalogGroup>
      <_cat:CatalogGroupIdentifier>
        <_wcf:UniqueID>10020</_wcf:UniqueID>
        <_wcf:ExternalIdentifier
ownerID="7000000000000000002">
         
<_wcf:GroupIdentifier>Clutches</_wcf:GroupIdentifier>
        </_wcf:ExternalIdentifier>
      </_cat:CatalogGroupIdentifier>
      <_cat:Description language="-1">
        <_cat:Name>Clutches</_cat:Name>
       
<_cat:Thumbnail>images/clutch_sub_sm.jpg</_cat:Thumbnail>
       
<_cat:ShortDescription>Clutches</_cat:ShortDescription>
      </_cat:Description>
    </_cat:CatalogGroup>
    <_cat:CatalogGroup>
      <_cat:CatalogGroupIdentifier>
        <_wcf:UniqueID>10021</_wcf:UniqueID>
        <_wcf:ExternalIdentifier
ownerID="7000000000000000002">
         
<_wcf:GroupIdentifier>Gears</_wcf:GroupIdentifier>
        </_wcf:ExternalIdentifier>
      </_cat:CatalogGroupIdentifier>
      <_cat:Description language="-1">
        <_cat:Name>Gears</_cat:Name>
       
<_cat:Thumbnail>images/gears_sub_sm.jpg</_cat:Thumbnail>
       
<_cat:ShortDescription>Gears</_cat:ShortDescription>
      </_cat:Description>
    </_cat:CatalogGroup>
    <_cat:CatalogGroup>
      <_cat:CatalogGroupIdentifier>
        <_wcf:UniqueID>10022</_wcf:UniqueID>
        <_wcf:ExternalIdentifier
ownerID="7000000000000000002">
         
<_wcf:GroupIdentifier>Differentials</_wcf:GroupIdentifier>
        </_wcf:ExternalIdentifier>
      </_cat:CatalogGroupIdentifier>
      <_cat:Description language="-1">
        <_cat:Name>Differentials</_cat:Name>
       
<_cat:Thumbnail>images/differential_sub_sm.jpg</_cat:Thumbnail>
       
<_cat:ShortDescription>Differentials</_cat:ShortDescription>
      </_cat:Description>
    </_cat:CatalogGroup>
  </_cat:DataArea>
</_cat:ShowCatalogGroup>
</soapenv:Body>
</soapenv:Envelope>

Usage

To use this service request on a JSP page use the expression-builder getCatalogGroupByParentCatalogGroupId.

The expression-builder maps to the following XPath expression:

{_wcf.ap=$accessProfile$}/CatalogGroup[ParentCatalogGroupIdentifier[(UniqueID='$catGroupId$')]]

The default is: accessProfile= WC_CatalogGroupSummaryProfile. 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
ComposeCatalogTaskCmd. By creating your own implementation of the
ComposeCatalogTaskCmd, and an access profile, you can control the information returned by the service.

Related Reference

WebSphere Commerce foundation tag library