SWQSTGetCatalogTree

 

Description

Returns the catalog Tree structure for the specified category in the category in the catalog.

Input is Category Name in the catalog.

Output recursively returns the child categories/models in the category.

In case of error, Error number and Error description are returned.

 

For a list of fault codes, see XML Faults.

 

Interface

 

<interfacename>

SWQSTGetCatalogTree

Name of interface

  <sessionid>

Id

Id of the active session

 

Parameters

 

<secure>

Secure

Security flag

<category>

CategoryName

Category Name. (required)

 

Return Values

 

<success>

Description

Success description

<returnval>

ReturnVal

Return Value. Category information

<category>

Category

Category node. This can contain more category nodes or model nodes.

 <name>

Name

Name of the category

<model>

Model

Model node. This node contains the attribute nodes associated with the model eg. <modeldisplayname>, <image>,<item> or modelname, <modeltype>, <title>

<modeldisplayname>

Model display name

Child node of <model>. This is the modeldisplayname.

<item>

Item

Child node of <model>.  This is the modelname.

<image>

http path

Child node of <model> or <category>.  Path to the model/categoryimage file.

<title>

Title

Child node of <model> or <category>.  Title of model/category.

<modeltype>

CADtype

This is either 2d for drawing or 3d for models.

 

Fault Values

 

<faultcode>

ErrorNumber

Error code

<faultstring>

Description

Description of the error

Remarks

 

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>SWQSTGetCatalogDetails</interfacename>

        <sessionid>0000</sessionid>

    </SOAP-ENV:Header>

    <SOAP-ENV:Body>

        <interfaceparameters>

            <secure>off</secure>

            <category>vimals</category>

        </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>SWQSTGetCatalogDetails</interfacename>

        <sessionid>0000</sessionid>

    </SOAP-ENV:Header>

    <SOAP-ENV:Body>

        <success>Success Description</success>

<returnval>

<category><name>VIMALS</name>

<category>

<name>ganesh-a</name>

<model><item>BOX</item><modeldisplayname>BOX</modeldisplayname>

<image>http://localhost/SWDownloads1/2044343787-401271//BOX.jpg</image>

<title></title><modeldisplayname>BOX</modeldisplayname>

<modeltype>3D</modeltype></model>

<image>http://localhost/SWDownloads1/2044343787-401271//DefaultCategoryImage.gif</image>

<title></title></category>

<model><item>AXLEASSEMBLY</item><modeldisplayname>AXLEASSEMBLY

</modeldisplayname>

<image>http://localhost/SWDownloads1/2044343787-401271//AXLEASSEMBLY.jpg</image>

<title></title><modeldisplayname>AXLEASSEMBLY</modeldisplayname>

<modeltype>3D</modeltype></model>

<image>http://localhost/SWDownloads1/2044343787-401271//home5.gif</image>

<title>VIMALS</title></category>

</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>SWQSTGetCatalogTree</interfacename>

        <sessionid>0000</sessionid>

    </SOAP-ENV:Header>

    <SOAP-ENV:Body>

        <faultcode>0000</faultcode>

        <faultstring>Description</faultstring>

    </SOAP-ENV:Body>

</SOAP-ENV:Envelope>