SWGetParamValues

 

Description

Return parameter information for the part.

 

For a list of fault codes, see XML Faults.

 

Interface

 

<interfacename>

SWGetParamValues

Name of interface.

<sessionid>

Id

Id of the active session.

 

Parameters

 

<secure>

Secure

Security flag.

<model>

ModelName

Name of the model.

<param>

Parameter

Parameter requested.

 

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.

<param_value>

param value

Parameter value.

<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.

 

Fault Values

 

<faultcode>

ErrorNumber

Error code.

<faultstring>

Description

Description of the error.

Remarks

 

The <param> node is optional. If without this node, PartStream will return all the parameters with all the possible values of this model.

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> indicates 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 previously selected.

If a parameter’s constraint is “range”, then these should have “minvalue”; “maxvalue”; “step” and “param_value” as the sub-node. The text of “param_value” is the value that was previously selected.

If the combination of the parameters selection matched with a standard configuration, then the <config> node will have value; otherwise it will be empty.

 

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

        <sessionid>2044355116-127636</sessionid>

    </SOAP-ENV:Header>

    <SOAP-ENV:Body>

        <interfaceparameters>

            <model>SHCS</model>

            <param attr="LENGTH">.5</param>

            <param attr="Size">#2</param>

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

        <interfacename>SWGetParamValues</interfacename>

    </SOAP-ENV:Header>

    <SOAP-ENV:Body>

        <sessionid>2044355116-127636</sessionid>

        <sessionid>2044355116-127636</sessionid>

        <returnVal>

        </returnVal>

            <param>

                <name>length</name>

                <minvalue>.1</minvalue>

                <maxvalue>.7</maxvalue>

                <step>.1</step>

                <constraint>Range</constraint>

                <value>.5</value>

            </param>

            <param>

                <name >Drive Type</name>

                <constraint>Choice</constraint>

                <value valid="true" type="input">Hex</value>

            </param>

            <param>

                <name>Thread Display</name>

                <constraint>Choice</constraint>

                <value valid="true" type="input">Simplified</value>

            </param>

            <param>

                <name state="enabled">Size</name>

                <constraint>Choice</constraint>

                <value valid="true">#0</value>

                <value valid="true">#1</value>

                <value valid="true" type="input">#2</value>

            </param>

            <param>

                <name>Aa</name>

                <constraint>Choice</constraint>

                <value valid="true" type="input">0.125</value>

            </param>

            <config>SHCS-Hex-Simplified-#2-0.125-.5</config>

        </returnval>

        <success>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>SWGetParamValues</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>