Description
Returns the category attribute information set for the specified category in the catalog.
Input is Category Name in the catalog.
Output is Properties of the concerned category like parent, title description, image, etc.
In case of error, error number (<faultcode>) and error description (<faultstring>) are returned.
For a list of fault codes, see XML Faults.
Interface
|
<interfacename> |
SWGetCategoryInfo |
Name of interface |
|
<sessionid> |
Id |
Id of the active session. |
Parameters
|
<secure> |
Secure |
Security flag. |
|
<category> |
String |
Category Name. (required). |
Return Values
|
<success> |
Description (String) |
Success description |
|
<returnval> |
ReturnVal |
Return Value. Category information. |
|
<category> |
Category name |
Category name. |
|
<parent> |
Parent category |
Name of the parent category. |
|
<title> |
Category title |
Title assigned to this category. |
|
<description> |
Description |
Description set for this category. |
|
<image> |
http path |
Path to the category image file. |
Fault Values
|
<faultcode> |
ErrorNumber |
Error code |
|
<faultstring>
|
Description |
Description of the error. |
Remarks
Sample SOAP/XML Request
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>SWGetCategoryInfo</interfacename>
<sessionid>0000</sessionid>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<interfaceparameters>
<secure>off</secure>
<category>Aluminum</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>SWGetCategoryInfo</interfacename>
<sessionid>0000</sessionid>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<success>Success Description</success>
<returnval>
<category>Aluminum</category>
<parent>Enclosures</parent>
<title>Rack Cases, Carrying Cases, Instrument Cases</title>
<description>some description</description
<image>http://www.3dpublisher.net/SWDownloads1/2044343787-401271//enclosure_preview.gif</name>
</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>SWGetCategoryInfo</interfacename>
<sessionid>0000</sessionid>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<faultcode>0000</faultcode>
<faultstring>Description</faultstring>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>