Description
Return parameter information for the part.
For a list of fault codes, see XML Faults.
Interface
|
<interfacename> |
SWGetParamsandconfigs |
Name of interface |
|---|---|---|
|
<sessionid> |
Id |
Id of the active session |
Parameters
|
<secure> |
Secure |
Security flag |
|
<model> |
ModelName |
Name of the model |
|
<configpagesize> |
PageSize |
Page size by rows |
|
<configspagenumber> |
PageNumber |
Page number |
|
<param attr> |
ParameterWidth |
Attribute width of the model |
Return Values
|
<success> <Sessionid> <ReturnDataMode> |
Description Id Data mode |
Success description Session Id number Data mode |
|
<returnval> |
param elements |
List of param elements |
|
<param> |
param info |
Parameter information. Parent of <name>, <constraint>, <value>, <value>. |
|
<name> |
param name |
Name of the parameter |
|
<constraint> |
constraint type |
Type of constraint - either Range or Choice |
|
<value> <value> <param> |
param value Param value |
Parameter value and type Parameter information. Parent of <name>, <constraint>, <value>, and <value>. |
|
<name> |
param name |
Name of parameter |
|
<constraint> |
constraint type |
Type of constraint - either Range or Choice |
|
<value> |
max value |
Maximum value for Range constraint type |
|
<value> |
step increment |
Step value for Range constraint type |
|
<config> |
configuration info |
Configuration information. Parent of <availableconfig>, and <configurationcount> |
|
<availableconfig> |
available configs |
Parameter value |
|
<configurationcount> |
configuration count |
Parameter count |
Fault Values
|
<faultcode> |
ErrorNumber |
Error code |
|
<faultstring>
|
Description |
Description of the error |
Remarks
The <param> attr="width"> is optional. If the param is without this node, PartStream returns all the configurations.
In the <param> node, the attribute: “attr” is the name of this parameter, and the text of this node is the current selection of this parameter.
In each <param> node, the <name> indicate the name of the parameter;
<constraint> indicate the type of the parameter: Choice or Range;
In each <value> node, if attribute “valid” equals to “true”, it is valid; if it equals to “false”, then it is invalid.
If a <value> node has an attribute called “type”, and it equals to “input”, it means that this value was picked previously.
If a parameter’s constraint is “range”, then there should have “minvalue”; “maxvalue”; “step” and “param_value” as the sub-node. The text of “param_value” is the value was picked previously.
If the combination of the parameters selection matched with a standard configuration, then the <config> node will have value; otherwise it will be empty.
The Response returns all the parameters and values, and then returns the matching configurations, based on the parameter passed in from the request.
Sample 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>SWGetParamsandConfigs</interfacename> <sessionid>2044352766-9273</sessionid> </SOAP-ENV:Header> <SOAP-ENV:Body> <interfaceparameters> <model>samplepart</model> <configpagesize>50</configpagesize> <configpagenumber>1</configpagenumber> <param attr="width">120<</param> </interfaceparameters> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |
Sample 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>SWGetParamsandConfigs</interfacename> <interfacename>SWGetParamsandConfigs</interfacename> </SOAP-ENV:Header> <SOAP-ENV:Body> <sessionId>2044352766-9273</sessionId> <sessionid>2044352766-9273</sessionid> <ReturnDataMode></ReturnDataMode> <returndatamode></returndatamode> <returnVal> </returnVal> <returnval> <param> <name state="enabled">width</name> <constraint>Choice</constraint> <value valid="true" type="input">120</value> <value valid="true">90</value> </param> <param> <name state="enabled">height</name> <constraint>Choice</constraint> <value valid="true">120</value> <value valid="true">90</value> <value valid="false">150</value> </param> <config/> <availableconfig configuration="First Instance"><param name="width" value="120"/> <param name="height" value="120"/></availableconfig> <availableconfig configuration="blk2"><param name="width" value="120"/> <param name="height" value="90"/></availableconfig> <availableconfig configuration="blk4"><param name="width" value="120"/> <param name="height" value="120"/></availableconfig> <availableconfig configuration="Default"><param name="width" value="120"/> <param name="height" value="120"/></availableconfig> <configurationcount>4</configurationcount> </returnval> <success>Success Description</success> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |