Description
Return an array of parameters and their values for a given configuration of the model.
Inputs are model name and configuration name.
Output is a list of parameter names and value pairs for that configuration of the model.
In case of error, error number (<faultcode>) and error description (<faultstring>) are returned.
For a list of fault codes, see XML Faults.
Interface
<interfacename> |
SWGetConfigParams |
Name of the interface |
---|---|---|
<sessionid> |
Id |
Id of the active session |
Parameters
<secure> |
Secure |
Security flag. |
<model> |
String |
Name of model |
<config> |
String |
Configuration name |
Return Values
<success> |
String |
Success description |
<returnval> |
param elements |
List of parameters |
<param> |
name,value pair |
Parameter information. Parent of <name> and <value>. |
<name> |
String |
Parameter name |
<value> |
Value |
Parameter value |
Fault Values
<faultcode> |
ErrorNumber |
Error code |
<faultstring>
|
Description |
Description of the error |
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>SWGetConfigParams</interfacename>
<sessionid>0000</sessionid>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<interfaceparameters>
<secure>off</secure>
<model>samplepart</model>
<config>blk2</config>
</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>SWGetConfigParams</interfacename>
<sessionid>0000</sessionid>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<sessionid>0000</sessionid>
<returnval>Available Configurations for ModelName
<param>
<name>width</name>
<value>100</value>
</param>
<param>
<name>height</name>
<value>150</value>
</param>
... as many as appropriate
</returnval>
<success>Description</success>
</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>SWGetConfigParams</interfacename>
<sessionid>0000</sessionid>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<sessionid>0000</sessionid>
<returnval></returnval>
<success>Description</success>
<faultcode>0000</faultcode>
<faultstring>Description</faultstring>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>