Description
This interface will return the list of available file formats for the specified type, 2D or 3D.
For a list of fault codes, see XML Faults.
Interface
|
<interfacename> |
SWGetDownloadFormats2 |
Name of interface |
|---|---|---|
|
<sessionid> |
Id |
Id of the active session |
Parameters
|
<secure> |
Secure |
Security flag. |
|
<enduser> |
Enduser |
Unique string logged in by every download or view request, optional |
|
<cadtype> |
Type |
Use 2D or 3D for values |
Return Values
|
<success> |
Description |
Success description |
|
<returnval> |
<formatinfo> |
List of available file formats for the given CAD type |
|
<formatinfo> |
<formatstring>, <format>, <psformat>, <version>, <psversion>, <units> |
Information about an individual format, may be multiple formats |
|
<formatstring> |
Description |
Description of the format |
|
<format> |
File extension |
File extension of the format |
|
<version> |
Version string |
Version available for the format. Each format can have multiple versions. |
|
<psformat> |
Psformat string |
Each <format> has one <psformat> associated with it. <psformat> is the equivalent neutral format corresponding to the native format specified in the <format> tag. |
|
<psversion> |
Psversion string |
Each version will contain an equivalent <psversion> tag. The information in <psformat> and <psversion> may be used to provide information about the type of format/file that will be returned if that format is requested. |
|
<units> |
string |
Units of the format |
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>SWGetDownloadFormats2</interfacename>
<sessionid>0000</sessionid>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<interfaceparameters>
<secure>off</secure>
<cadtype>3D</cadtype>
</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>SWGetDownloadFormats2</interfacename>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<sessionid>0000</sessionid>
<returnval>Available Download Formats for cadtype
<formatinfo>
<formatstring>SolidWorks Assembly</formatstring>
<format>sldasm</format>
</formatinfo>
<formatinfo>
<formatstring>IGES</formatstring>
<format>igs</format>
</formatinfo>
<formatinfo>
<format>mdt</format>
<formatstring>Mechanical Desktop</formatstring>
<psformat>sat</psformat>
<version><value>R2</value><psversion>3.0</psversion></version>
<version><value>R3</value><psversion>4.0</psversion></version>
<version><value>R4</value><psversion>5.0</psversion></version>
<version><value>R5</value><psversion>6.0</psversion></version>
<version><value>R6</value><psversion>6.0</psversion></version>
</formatinfo>
<formatinfo>
<format>sat</format>
<formatstring>ACIS Files</formatstring>
<version>6.0</version>
<version>5.5</version>
... as many as necessary
</formatinfo>
</returnval>
</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>SWGetDownloadFormats2</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>