SWGetCategoryTree6

This XML request is valid starting with 3DPartStream.NET, Version 7, and is used for localization. For versions prior to Version 7, use SWGetCategoryTree (prior to Version 6) or SWGetCategoryTree4.

Description

Return the category tree (model name and model display name) in the catalog.

Input is Category Name.

Output is hierarchy of subcategories and models under the given category. If given category is empty then entire Category Tree is returned.

In case of error, error number (<faultcode>) and error description (<faultstring>) are returned.

For a list of fault codes, see XML Faults.

Interface

<interfacename>	SWGetCategoryTree6	Name of interface
<sessionid>	Id	Id of the active session.

Parameters

<ReturnDataMode>	Mode of data returned	Returns the data mode for <viewimage> as a hyperlink to the image.
<category>	CategoryName	Category Name. If this tag is omitted, the entire tree is returned.
<level>	Level Index	Level of descendants to return starting from the category requested. If omitted, the entire tree from the requested category will be returned.
<listmodels>	Model list	List of models returned.
<listmodelcount>	Model count	Number of models under sub categories to the main category.
<language>	Language	Language returned.
<viewimage>	Image returned	Hyper link to image returned.
<pagesize>	Page size	Number of items returned per page.
<page>	Pages	Number of pages returned.

Return Values

<success>	Description	Success description
<returnval>	ReturnVal	Return Value. The hierarchy of subcategories and models under the given category.
<datafile>	DataFile	Data file.
<category>	Category	The subcategories. Parent element of <name>.
<level>	Subcategory	Level of the subcategory.
<item>	Item	Item under the category. Parent element <model> and <modeldisplayname>.
<listmodel>	Model list	Number of models in the subcategory.
<listmodelcount>	Model count	Number of models under sub categories to the main category.
<language>	Language	Language returned
<viewimage>	Image returned	Hyper link to view the iamge
<pagesize>	Page size	Number of items per page.
<page>	Number of pages
<modeldisplayname>	Display name	Display name of item.

Fault Values

ErrorNumber

Error code

Description

Description of the error

Remarks

If level = 1, the immediate child categories and models are returned.
If level = 2, the child categories and models and their child categories and models are returned.
If level = n, the child categories and models up the level n are returned.

Sample SOAP/XML Request

<SOAP-ENV:Envelope

xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"

SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">

<SOAP-ENV:Header>

<interfacename>SWGetCategoryTree4</interfacename>

</SOAP-ENV:Header>

<SOAP-ENV:Body>

<interfaceparameters>

<ReturnDataMode>HyperLink</ReturnDataMode>

<listmodelcount>false</listmodelcount>

</interfaceparameters>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

Sample SOAP/XML Success Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">

<SOAP-ENV:Header>

<InterfaceName>SWGetCategoryTree6</InterfaceName>

<interfacename>SWGetCategoryTree6</interfacename>

</SOAP-ENV:Header>

<SOAP-ENV:Body>

<ReturnDataMode>HyperLink</ReturnDataMode>

<returndatamode>HyperLink</returndatamode>

</returnVal>

<category><name>publish3d101</name><display_name>PUBLISH3D display</display_name><title>PUBLISH3D</title><image>http://stagedev/showmodels/PUBLISH3D/categories/publish3d101/DefaultCategoryImage.gif</image><category><name>Bolts and Nuts</name><display_name>Bolts and Nuts</display_name><title>at Root</title><image>http://stagedev/showmodels/PUBLISH3D/categories/Bolts and Nuts/DefaultCategoryImage.gif</image></category><category><name>Bearings</name><display_name>Bearings</display_name><title></title><image>http://stagedev/showmodels/PUBLISH3D/categories/Bearings/DefaultCategoryImage.gif</image></category><category><name>Assembly_29</name><display_name>Assembly ® test</display_name><title>Assembly title</title><image>http://stagedev/showmodels/PUBLISH3D/categories/Assembly_29/DefaultCategoryImage.gif</image></category><category><name>batch_test</name><display_name>batch_test</display_name><title></title><image>http://stagedev/showmodels/PUBLISH3D/categories/batch_test/bigkitten.jpg</image></category><category><name>Developers</name><display_name>Developers</display_name><title>Testing title</title><image>http://stagedev/showmodels/PUBLISH3D/categories/Developers/DefaultCategoryImage.gif</image></category><category><name>Drawings32Various</name><display_name>Drawings Various</display_name><title></title><image></image></category><category><name>Electro-Pneumatic32Cylinders</name><display_name>Electro-Pneumatic Cylinders</display_name><title>ddfdfdf</title><image>http://stagedev/showmodels/PUBLISH3D/categories/Electro-Pneumatic32Cylinders/samplepart.gif</image></category><category><name>Fillets</name><display_name>Fillets</display_name><title></title><image>http://stagedev/showmodels/PUBLISH3D/categories/Fillets/DefaultCategoryImage.gif</image></category><category><name>My32Design32Table32Parts</name><display_name>My Design Table Parts</display_name><title></title><image>http://stagedev/showmodels/PUBLISH3D/categories/My32Design32Table32Parts/category_folder.gif</image></category><category><name>Part_30</name><display_name>Part</display_name><title>Part title</title><image>http://stagedev/showmodels/PUBLISH3D/categories/Part_30/cm block 2.jpg</image></category><category><name>PubCategory12</name><display_name>PubCategory12</display_name><title>sdsdsddsdd</title><image></image></category><category><name>Sample Lofts</name><display_name>Sample Lofts</display_name><title></title><image>http://stagedev/showmodels/PUBLISH3D/categories/Sample Lofts/loft_no_thin_feature.gif</image></category><category><name>Sample Patterns</name><display_name>Sample Patterns</display_name><title></title><image></image></category><category><name>something</name><display_name>something</display_name><title></title><image>http://stagedev/showmodels/PUBLISH3D/categories/something/DefaultCategoryImage.gif</image></category><category><name>sub cat 4</name><display_name>sub cat 4</display_name><title></title><image>http://stagedev/showmodels/PUBLISH3D/categories/sub cat 4/DefaultCategoryImage.gif</image></category><category><name>sub cat 5</name><display_name>sub cat 5</display_name><title></title><image>http://stagedev/showmodels/PUBLISH3D/categories/sub cat 5/DefaultCategoryImage.gif</image></category><category><name>sub cat 6</name><display_name>sub cat 6</display_name><title></title><image>http://stagedev/showmodels/PUBLISH3D/categories/sub cat 6/DefaultCategoryImage.gif</image></category><category><name>sub cat 7</name><display_name>sub cat 7</display_name><title></title><image>http://stagedev/showmodels/PUBLISH3D/categories/sub cat 7/DefaultCategoryImage.gif</image></category><category><name>sub cat 8</name><display_name>sub cat 8</display_name><title></title><image>http://stagedev/showmodels/PUBLISH3D/categories/sub cat 8/DefaultCategoryImage.gif</image></category><category><name>sub cat 9</name><display_name>sub cat 9</display_name><title></title><image>http://stagedev/showmodels/PUBLISH3D/categories/sub cat 9/DefaultCategoryImage.gif</image></category><category><name>TestPCategory</name><display_name>TestPCategory</display_name><title>ddfdfdfd</title><image>http://stagedev/showmodels/PUBLISH3D/categories/TestPCategory/Splash.gif</image></category></category></returnval>

<success>Success Description</success>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

Sample SOAP/XML Error Response