This XML request is valid starting with 3DPartStream.NET,
Version 6. For versions prior to Version 6, use SWGetCategoryTree.
This XML request is valid starting with 3DPartStream.NET,
Version 6. For versions prior to Version 6, use SWGetCategoryTree.
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> |
SWGetCategoryTree4 |
Name of interface |
|
<sessionid> |
Id |
Id of the active session. |
Parameters
|
<secure> |
Secure |
Security flag. |
|
<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. |
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>. |
|
<name> |
Name |
Name of subcategory. |
|
<item> |
Item |
Item under the category. Parent element <model> and <modeldisplayname>. |
|
<model> |
Part name |
Part name of item. |
|
<modeldisplayname> |
Display name |
Display name of item. |
Fault Values
|
<faultcode> |
ErrorNumber |
Error code |
|
<faultstring>
|
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>
<sessionid>0000</sessionid>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<interfaceparameters>
<secure>off</secure>
<category>DSubProducts</category>
<level>1</level>
</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>SWGetCategoryTree</interfacename>
<sessionid>0000</sessionid>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<success>Success Description</success>
<returnval>
<category>
<name>Adapters</name>
</category>
<category>
<name>Couplers</name>
</category>
<category>
<name>Splitters</name>
</category>
<item><model>DSUB15M</model><modeldisplayname>DSUB15M</modeldisplayname></item>
<item><model>DSUB15MF</model><modeldisplayname>DSUB15MF</modeldisplayname</item>
... as many as appropriate
</returnval>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample SOAP/XML Error 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>SWGetCategoryTree</interfacename>
<sessionid>0000</sessionid>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<faultcode>0000</faultcode>
<faultstring>Description</faultstring>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>