Get catalog group summary by identifier

This service request, getCatalogGroupSummaryByIdentifier, obtains detailed information about a category such as:

• catalog group ID

• owner ID

• catalog group identifier

• name

• short description

• thumbnail image

A list of CatalogGroup nouns returns if you pass in multiple catalog group identifiers. The catalog group identifier is used in the request.

 

Request

Request BOD	GetCatalogGroup
Access profile	WC_CatalogGroupSummaryProfile
Schema	/Catalog-DataObjects/xsd/OAGIS/9.0/Overlays/IBM/Commerce/BODs/GetCatalogGroup.xsd
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:38:41.776Z
                </oa:CreationDateTime>
               
<oa:BODID>a8e003c0-acab-11db-b421-832d45b90741</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_CatalogGroupSummaryProfile}/CatalogGroup[CatalogGroupIdentifier[ExternalIdentifier[GroupIdentifier='Batteries']]]
                        </oa:Expression>
                </oa:Get>
        </_cat:DataArea>
</_cat:GetCatalogGroup>

 

Response

Response BOD	ShowCatalogGroup
Schema	/Catalog-DataObjects/xsd/OAGIS/9.0/Overlays/IBM/Commerce/BODs/GetCatalogGroup.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

 

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:38:42.517Z
                </Oagis9:CreationDateTime>
                <Oagis9:BODID>
                        a9987e50-acab-11db-83a9-832d45b8fe37
                </Oagis9:BODID>
        </Oagis9:ApplicationArea>
        <_cat:DataArea>
                <Oagis9:Show recordSetCompleteIndicator="false"
/>
                <_cat:CatalogGroup>
                        <_cat:CatalogGroupIdentifier>
                               
<_wcf:UniqueID>10011</_wcf:UniqueID>
                                <_wcf:ExternalIdentifier
                                       
ownerID="7000000000000000002">
                                       
<_wcf:GroupIdentifier>
                                                Batteries
                                       
</_wcf:GroupIdentifier>
                                </_wcf:ExternalIdentifier>
                        </_cat:CatalogGroupIdentifier>
                        <_cat:Description language="-1">
                               
<_cat:Name>Batteries</_cat:Name>
                                <_cat:Thumbnail>
                                        images/battery_sub_sm.jpg
                                </_cat:Thumbnail>
                               
<_cat:ShortDescription>Batteries</_cat:ShortDescription>
                        </_cat:Description>
                </_cat:CatalogGroup>
        </_cat:DataArea>
</_cat:ShowCatalogGroup>

 

Usage

To use this service request on a JSP page use the expression-builder, getCatalogGroupSummaryByIdentifier, and pass the catGroupIdentifier parameter. This maps to the following XPath expression:

{_wcf.ap=$accessProfile$}/CatalogGroup[CatalogGroupIdentifier[ExternalIdentifier[GroupIdentifier='$catGroupIdentifier$']]]

The default is: accessProfile=WC_CatalogGroupSummaryProfile.

By default, the expression builder in the get-data-config.xml file associated to this service only accepts one id or identifier. By using the pattern from getCatalogGroupSummaryByIDs or getCatalogGroupDetailsbyIDs, you can create your own expression builder that will accept multiple IDs or identifiers.

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