SWGetConfigInfo

 

Description

Return an array of configurations of the part. Each element of the array will provide the config name.

Inputs are model name and search string to find all matching configurations. If the search string is blank then all configurations are returned.

Output is a list of configurations of the part that match the search string.

In case of error, error number (<faultcode>) and error description (<faultstring>) are returned.

 

For a list of fault codes, see XML Faults.

 

Interface

 

<interfacename>

SWGetConfigInfo

Name of configuration

<sessionid>

Id

Id of the active session

 

Parameters

 

<secure>

Secure

Security flag.

<model>

Model Name

Name of the model to search

<searchstring>

String

String to use for the search

 

Return Values

 

<returnval>

config elements

List of matching configurations

<config>

String

Name of a matching configuration

 

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

        <sessionid>0000</sessionid>

    </SOAP-ENV:Header>

    <SOAP-ENV:Body>

        <interfaceparameters>

            <secure>off</secure>

            <model>ModelName</model>

            <searchstring>blk</searchstring>

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

        <sessionid>0000</sessionid>

    </SOAP-ENV:Header>

    <SOAP-ENV:Body>

        <sessionid>0000</sessionid>

        <returnval>Available Configurations for ModelName

            <config>blk2</config>

            <config>blk3</config>

 

            ... 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>SWGetConfigInfo</interfacename>

        <sessionid>0000</sessionid>

    </SOAP-ENV:Header>

    <SOAP-ENV:Body>

        <sessionid>0000</sessionid>

        <returnval></returnval>

        <success>Description</success>

        <faultcode>Error Number</faultcode>

        <faultstring>Description</faultstring>

    </SOAP-ENV:Body>

</SOAP-ENV:Envelope>