Description
Return an array of parameters of the part. Each element of the array will provide a parameter of the part.
Input is the model name.
Output is a list of parameters for 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> |
SWGetAllParams |
Name of the interface |
|---|---|---|
|
<sessionid> |
Id |
Id of the active session |
Parameters
|
<secure> |
Secure |
Security flag. |
|
<model> |
ModelName |
Name of the model |
Return Values
|
<success> |
Description |
Success description |
|
<returnval> |
param elements |
List of param elements |
|
<param> |
param info |
Parameter information. Parent of <name>, <constraint>, <minvalue>, <maxvalue>, and <step>. |
|
<name> |
param name |
Name of the parameter |
|
<constraint> |
constraint type |
Type of constraint - either Range or Choice |
|
<minvalue> |
min value |
Minimum value for Range constraint type |
|
<maxvalue> |
max value |
Maximum value for Range constraint type |
|
<step> |
step increment |
Step value for Range constraint type |
|
<value> |
param value |
Parameter value for Choice constraint type |
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>SWGetAllParams</interfacename>
<sessionid>0000</sessionid>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<interfaceparameters>
<secure>off</secure>
<model>ModelName</model>
</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>SWGetAllParams</interfacename>
<sessionid>0000</sessionid>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<sessionid>0000</sessionid>
<returnval>Available Parameters for samplepart
<param>
<name>width</name>
<constraint>Range</constraint>
<minvalue>10</minvalue>
<maxvalue>400</maxvalue>
<step>NA</step>
</param>
<param>
<name>height</name>
<constraint>Choice</constraint>
<value>120</value>
<value>150</value>
<value>90</value>
<value>100</value>
<value>200</value>
... as many as appropriate
</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>SWGetAllParams</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>