This is an old revision of the document!
Table of Contents
CategoryQueryRs (Response)
Posting a proper CategoryQueryRq request will result in the output of the requested information in a simple print format (read with stdin). The CategoryQueryRs is the response to the CategoryQueryRq request and contains all information pertinent to the requested categories.
Sample Response:
<?xml version="1.0" ?> <F3XML> <F3XMLRs> <CategoryQueryRs RequestID="1"> <Category> <Name>Televisions</Name> <Description>LED LCD and Plasma Televisions by Sony and Panasonic</Description> <AdditionalDesc></AdditionalDesc> <Image>http://www.mediaworldag.com/img-televisions.jpg</Image> <ImageThumb>http://www.mediaworldag.com/img-icon-televisions.jpg</ImageThumb> <CatURL>http://www.mediaworldag.com/Products-Televisions.html</CatURL> <F3ID>1188</F3ID> <Visibility>Retail/Wholesale</Visibility> </Category> <Category> <Name>Sony</Name> <Description>Sony LED LCD Televisions Provide the Highest Image Quality in the Industry</Description> <AdditionalDesc></AdditionalDesc> <Image>http://www.mediaworldag.com/img-sony_televisions.jpg</Image> <ImageThumb>http://www.mediaworldag.com/img-icon-sony_televisions.jpg</ImageThumb> <CatURL>http://www.mediaworldag.com/Televisions-Sony.html</CatURL> <MetaTags> <MetaTitle>Sony LED Televisions by MediaWorldAG</MetaTitle> <MetaDescription>Our Sony LED LCD Televisions are Priced at Wholesale Discounts.</MetaDescription> <MetaKeywords>Sony, LED, LCD, Televisions, TVs, TV, 3D</MetaKeywords> </MetaTags> <F3ID>1189</F3ID> <Visibility>Retail/Wholesale</Visibility> <ParentCategories>Televisions</ParentCategories> </Category> <Category> <Name>Panasonic</Name> <Description>Panasonic LED LCD Televisions are Durable and impressive in Quality</Description> <AdditionalDesc></AdditionalDesc> <Image>http://www.mediaworldag.com/img-panasonic_televisions.jpg</Image> <ImageThumb>http://www.mediaworldag.com/img-icon-panasonic_televisions.jpg</ImageThumb> <CatURL>http://www.mediaworldag.com/Televisions-Panasonic.html</CatURL> <MetaTags> <MetaTitle>Panasonic LED Televisions by MediaWorldAG</MetaTitle> <MetaDescription>Our Panasonic LED LCD Televisions are Priced at Wholesale Discounts.</MetaDescription> <MetaKeywords>Panasonic, LED, LCD, Televisions, TVs, TV, 3D</MetaKeywords> </MetaTags> <F3ID>1190</F3ID> <Visibility>Retail/Wholesale</Visibility> <ParentCategories>Televisions</ParentCategories> </Category> </CategoryQueryRs> </F3XMLRs> </F3XML>
Response Fields
Tag Name | Sub-Tag Of | Description | Returned | Field Type | Can Repeat |
---|---|---|---|---|---|
Category | CategoryQueryRs | The Category's Node | Always | Node | True |
Name | Category | The Category's Name | Always | String | False |
Description | Category | The Category's Description | Always | String | False |
AdditionalDesc | Category | The Category's Additional Description | Always | String | False |
Image | Category | The Category's Full-size Image | Always | String (URL) | False |
ImageThumb | Category | The Category's Thumbnail Image | Always | String (URL) | False |
CatURL | Category | The Category Page URL | Always | String (URL) | False |
MetaTags | Category | Meta Tags Node | * If Active Only | Node | False |
MetaTitle | MetaTags | The Category's 'Title' Meta Tag | * If Active | String | False |
MetaDescription | MetaTags | The Category's 'Description' Meta Tag | * If Active | String | False |
MetaKeywords | MetaTags | The Category's 'Keywords' Meta Tag | * If Active | String | False |
F3ID | Category | The Internal ID for the Category | Always | Number | False |
Visibility | Category | Specifies 'Show Category On' Field | Always | String: “Retail/Wholesale” “Retail” “Wholesale” “Hidden” | False |
ParentCategories | Category | The Category's Full Path | * If Sub-Category Only | String Format: Category→SubCategory | False |