Note: This XML request is valid starting with 3DPartStream.NET, Version 6. For versions prior to Version 6, use SWGetAllModels.
Description
Return an array of models (model name and model display name) available in the catalog. You can use % as a wildcard value in your search string.
Input is a search string to get all matching models. If the search string is blank then all models in the catalog are returned.
Output is a list of models in the catalog that match the search string.
In case of error, error number (<faultcode>) and error description (<faultstring>) are returned.
For a list of fault codes, see XML Faults.
Interface
|
<interfacename> |
SWGetAllModels2 |
|
| |
|---|---|---|---|---|
|
<sessionid> |
Id |
Id of the active session |
|
|
Parameters
|
<secure> |
Secure |
Security flag. |
|
<searchstring> |
String |
String to be used in the search. |
Return Values
|
<success> |
Description |
Success description. |
|
<returnval> |
model elements |
List of models matching the search string. |
|
<item> |
Matching item |
Matching item. |
|
<model> |
Model name |
Model name of matching item. |
|
<modeldisplayname> |
Display name |
Model display name of matching item. |
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>SWGetAllModels2</interfacename>
<sessionid>0000</sessionid>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<interfaceparameters>
<secure>off</secure>
<searchstring>%Cylinder%</searchstring>
</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>SWGetAllModels2</interfacename>
<sessionid>0000</sessionid>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<sessionid>0000</sessionid>
<returnval>List of Models in this Catalog
<item><model>05in Bore Cylinder</model><modeldisplayname></modeldisplayname>05in Bore Cylinder</item>
<item><model>1in Bore Cylinder</model><modeldisplayname></modeldisplayname>1in Bore Cylinder</item>
... as many as appropriate
</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>SWGetAllModels2</interfacename>
<sessionid>0000</sessionid>
</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>