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> |
SWGenerateConfigDownload2D |
Name of the interface |
|---|---|---|
|
<sessionid> |
Id |
Id of the active session |
Parameters
|
<secure> |
Security |
Security flag. |
|
<model> |
ModelName |
Name of the file to obtain |
|
<drwview> |
DrawingView |
Name of the drawing view to obtain. See below. |
|
<config> |
ConfigurationName |
Name of the configuration to use, optional |
|
<enduser> |
Enduser |
Unique string logged in by every download or view request, optional |
|
<formatinfo> |
FormatInfo |
Parent element containing <format>, <version>, and <units>. |
|
<format> |
FormatName |
Name of the file format to use |
|
<version> |
Version |
Version of the file |
|
<archive> |
Archive |
on/off flag to indicate whether the file should be archived and delivered in ZIP format. Optional - default is off. |
|
<units> |
Units |
Units used in the file |
|
<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 following are the valid values for the <drwview> tag:
*none - if there is no drawing present, this option will return a "No drawing is present" response
if a drawing is present, it is used with the parameters supplied to generate the output
*front, *left, *right, *top, *bottom, *back, *isometric, *dimetric, *trimetric -
these options will generate the appropriate views for the given configuration whether it is STANDARD or PARAMETRIC.
*multi - this option is similar to the above except that it generates a drawing with the following 7 views: *front, *top, *bottom, *left, *right, *back, *isometric
*4view - this option
is similar to the above except that it generates a drawing with the following
4 views: *front, *top, *right, *isometric
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>SWGenerateConfigDownload2D</interfacename>
<sessionid>0000</sessionid>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<interfaceparameters>
<secure>off</secure>
<model>modelName</model>
<drwview>*front</drwview>
<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>SWGenerateConfigDownload2D</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>SWGenerateConfigDownload2D</interfacename>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<sessionid>0000</sessionid>
<returnval></returnval>
<success>Success Description</success>
<faultcode>0000</faultcode>
<faultstring>Description</faultstring>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>