SWGetConfigView3D

 

Description

Given a model and configuration name, this Interface returns a link to a viewable file for the specified configuration.

 

For a list of fault codes, see XML Faults.

 

Interface

 

 

<interfacename>

SWGetConfigView3D

Name of the interface

<sessionid>

Id

Id of the active session

 

Parameters

 

<secure>

Secure

Security flag.

<model>

ModelName

Name of the file to obtain

<enduser>

Enduser

Unique string logged in by every download or view request, optional

<config>

ConfigurationName

Name of the configuration to use

 

Return Values

 

<success>

Description

Success description

<returnval>

Hyperlink

Link to the necessary output

 

Fault Values

 

<faultcode>

ErrorNumber

Error code

<faultstring>

Description

Description of the error

 

Remarks

The ModelName is the full pathname to the model on the server.

The returned Hyperlink represents the file used to download the model for viewing.

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

        <sessionid>0000</sessionid>

    </SOAP-ENV:Header>

    <SOAP-ENV:Body>

        <interfaceparameters>

            <secure>off</secure>

            <model>modelName</model>

            <config>configurationName</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>SWGetConfigView3D</interfacename>

    </SOAP-ENV:Header>

    <SOAP-ENV:Body>

        <sessionid>0000</sessionid>

        <returnval>Link to requested output</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>SWGetConfigView3D</interfacename>

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