Description
Given a model and configuration name and/or parameters that can drive the model and desired output format, this Interface returns a link to a file that contains the model in the specified configuration and format.
For a list of fault codes, see XML Faults.
Interface
|
<interfacename> |
SWGenerateConfigDownload3D |
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, optional |
|
<formatinfo> |
FormatInfo |
Parent element containing <format> and <version>. |
|
<format> |
FormatName |
Name of the file format to use |
|
<version> |
Version |
Version of the file |
|
<detail> |
Detail |
Only applies to SolidWorks formats sldprt and sldasm. If <detail> is set to "All", SolidWorks formats with Features will be returned. If <detail> is set to "Geometry", only the geometry will be returned without Features. |
|
<archive> |
Archive |
on/off flag to indicate whether the file should be archived and delivered in ZIP format. Optional - default is off. |
|
<param attr="Name"> |
ParamValue |
Value for the named parameter, optional, use as many as necessary |
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.
There is no enforcement of rules for parameter names or values. For example, any invalid parameter names are simply ignored. As long as a configuration was successfully generated from the parameters supplied, that configuration will be returned and will also be cached with the name provided on input. This cached configuration will then be returned on any subsequent SWGetConfigDownload3D calls that match this configuration name.
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>SWGenerateConfigDownload3D</interfacename>
<sessionid>0000</sessionid>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<interfaceparameters>
<secure>off</secure>
<model>modelName</model>
<config>configurationName</config>
<formatinfo>
<format>formatName</format>
<version>5.5</version>
</formatinfo>
<archive>on</archive>
<param attr="Dim1">configDim1</param>
<param attr="Dim2">configDim2</param>
<param attr="...">configDim...</param>
<param attr="DimX">configDimX</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>SWGenerateConfigDownload3D</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>SWGenerateConfigDownload3D</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>