Description
Given a model name, a link to a viewable file for the model is returned.
For a list of fault codes, see XML Faults.
Interface
|
<interfacename> |
SWGetModelView3D |
Name of 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 |
|
<operatingsystem> |
OperatingSystemName |
Name of the operating system of the browser sending the request. Currently supports Windows and Unix. If this tag is not found, Windows is assumed. |
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 represents the name of the model being requested.
The required login elements are <catalog>, <serviceuser>, and <password> &ldots;
If the required sessionid element is missing or is an invalid sessionid, the request performs the login if all SWSessionLogin elements are available. The required login elements are <catalog>, <serviceuser> and <password> as documented in SWServiceLogin . These additional elements should be placed in the <interfaceparameters> element of the request.
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>SWGetModelView3D</interfacename>
<sessionid>0000</sessionid>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<interfaceparameters>
<secure>off</secure>
<model>modelName</model>
<operatingsystem>unix</operatingsystem>
</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>SWGetModelView3D</interfacename>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<sessionid>0000</sessionid>
<returnval>Link to the attachment</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>SWGetModelView3D</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>