Overview 
Namespace 
WSDL 
Schema 
 Component 
Index 
PREV C-TYPE   NEXT C-TYPE
FRAMES   NO FRAMES NS-Bindings
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API
complexType "ns:GetCategoryFeaturesRequestType"
Namespace:
urn:ebay:apis:eBLBaseComponents
Content:
complex, 15 elements, elem. wildcard
Defined:
globally in Schema in ebaySvc.wsdl; see XML source
Includes:
definitions of 5 elements
Used:
at 1 location
Component Diagram
XML Representation Summary
<...>
   
Content: 
ns:DetailLevel*, ns:ErrorLanguage?, ns:MessageID?, ns:Version?, ns:EndUserIP?, ns:ErrorHandling?, ns:InvocationID?, ns:OutputSelector*, ns:WarningLevel?, ns:BotBlock?, {any}*, ns:CategoryID?, ns:LevelLimit?, ns:ViewAllNodes?, ns:FeatureID*, ns:AllFeaturesForCategory?
</...>
All Direct / Indirect Based Elements (1):
ns:GetCategoryFeaturesRequest
Known Usage Locations
Annotation
Returns information about the features that are applicable to different categories, such as listing durations, shipping term requirements, and Best Offer support.
Type Definition Detail
Type Derivation Tree
ns:AbstractRequestType (extension)
  ns:GetCategoryFeaturesRequestType
XML Source (w/o annotations (6); see within schema source)
<xs:complexType name="GetCategoryFeaturesRequestType">
<xs:complexContent>
<xs:extension base="ns:AbstractRequestType">
<xs:sequence>
<xs:element minOccurs="0" name="CategoryID" type="xs:string"/>
<xs:element minOccurs="0" name="LevelLimit" type="xs:int"/>
<xs:element minOccurs="0" name="ViewAllNodes" type="xs:boolean"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="FeatureID" type="ns:FeatureIDCodeType"/>
<xs:element minOccurs="0" name="AllFeaturesForCategory" type="xs:boolean"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Content Element Detail (all declarations defined in this component; 5/16)
ns:AllFeaturesForCategory
Type:
xs:boolean, predefined, simple content
Use this switch to view all of the feature settings for a specific category. All feature settings are returned, regardless of the site default settings. This element works in conjunction with CategoryID--refer to the notes for that element for more details.

If you also set FeatureID, eBay returns the status of the specified features only, for the specified category.
XML Representation Summary
<ns:AllFeaturesForCategory>
   
Content: 
{ xs:boolean }
</ns:AllFeaturesForCategory>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="AllFeaturesForCategory" type="xs:boolean"/>
ns:CategoryID
Type:
xs:string, predefined, simple content
Specifies the category for which you want to retrieve the feature settings.

Specify a CategoryID, set DetailLevel to ReturnAll, and set ViewAllNodes to true to return the default site settings, the overrides for the specified category, plus all the child categories that have overrides on the features they inherit.

If you also set AllFeaturesForCategory to true, eBay returns the site defaults, plus all the settings for the specified category. Child category information is not returned in this case.

If CategoryID is not specified, eBay returns the feature settings for the site. To return details on all categories that have overrides on the properties they inherit, set DetailLevel to ReturnAll, and set ViewAllNodes to true. If you also set AllFeaturesForCategory to true, eBay returns only the site defaults with no child category information.
XML Representation Summary
<ns:CategoryID>
   
Content: 
{ xs:string }
</ns:CategoryID>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="CategoryID" type="xs:string"/>
ns:FeatureID
Type:
ns:FeatureIDCodeType, simple content
Use this field if you want to know if specific features are enabled at the site or root category level. Multiple FeatureID elements can be used in the request. If no FeatureID elements are used, the call retrieves data for all features, as applicable to the other request parameters.
XML Representation Summary
<ns:FeatureID>
   
Content: 
{ enumeration of xs:token }
</ns:FeatureID>
Simple Content
Enumeration:
see details at ns:FeatureIDCodeType
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="FeatureID" type="ns:FeatureIDCodeType"/>
ns:LevelLimit
Type:
xs:int, predefined, simple content
This field is used if the user wants to control the maximum depth of the category hierarchy to retrieve, or in other words, how many levels of eBay categories that are returned in the response. If this field is omitted, and no CategoryID is specified, eBay feature metadata for every eBay category from the root on down will be returned. If this field is omitted, but a CategoryID is specified, the specified category and all of its children (down to the leaf categories) are returned.

If the CategoryID field is not used, but the LevelLimit field is used and set to 1, eBay feature metadata is only returned for the top-level categories (also known as L1 categories).
XML Representation Summary
<ns:LevelLimit>
   
Content: 
{ xs:int }
</ns:LevelLimit>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="LevelLimit" type="xs:int"/>
ns:ViewAllNodes
Type:
xs:boolean, predefined, simple content
You must set DetailLevel to ReturnAll in order to correctly populate the response when you set ViewAllNodes to true. In this case, eBay returns the site defaults along with all the categories that override the feature settings they inherit. Here, each Category container shows only the features that it has overridden from its parent node.

If you also specify a CategoryID, eBay returns the details for that category, along with containers for each of its child categories that have feature overrides.

Note that if ViewAllNodes is set to false (the default) and DetailLevel is set to ReturnAll, eBay returns only the leaf categories that have features that override the settings they inherit. In this case, the call will not return leaf categories that do not have overrides.
XML Representation Summary
<ns:ViewAllNodes>
   
Content: 
{ xs:boolean }
</ns:ViewAllNodes>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ViewAllNodes" type="xs:boolean"/>
Overview 
Namespace 
WSDL 
Schema 
 Component 
Index 
PREV C-TYPE   NEXT C-TYPE
FRAMES   NO FRAMES NS-Bindings
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API
WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.