Description
This interface performs a login to a 3DPartStream.NET service session.
For a list of fault codes, see XML Faults.
Interface
|
<interfacename> |
SWServiceLogin |
Name of interface |
|---|
Parameters
|
<secure> |
Secure |
Security flag |
|
<catalog> |
CatalogName |
Name of the catalog to log into |
|
<serviceuser> |
ServiceLogin |
Login name of the service user |
|
<password> |
Password |
Password of the service user |
|
<enduser> |
UserLogin |
Login name of the end user (Currently unused) |
Return Values
|
<success> |
Description |
Success description |
|
<sessionid> |
Id |
Id of the new session |
Fault Values
|
<faultcode> |
ErrorNumber |
Error code |
|
<faultstring> |
Description |
Description of the error |
Remarks
The CatalogName is the name of the catalog that the user targets their requests at for the current 3DPartStream.NET session.
The ServiceLogin and Password provide "read-only" access to the requested catalog.
The UserLogin is the name of the end user for whom the request is made. Currently this field is not used.
Once the ServiceLogin and Password have been accepted, a new 3DPartStream.NET session is created. The new session will be returned as a sessionid. The sessionid is provided as an argument for all subsequent requests made to 3DPartStream.NET.
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>SWServiceLogin</interfacename>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<interfaceparameters>
<secure>off</secure>
<catalog>CatalogName</catalog>
<serviceuser>ServiceLogin</serviceuser>
<password>ServicePassword</password>
</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>SWServiceLogin</interfacename>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<sessionid>0000</sessionid>
<returnval></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>SWServiceLogin</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>