SOAP Actions
OpenDocuframeDB
Method that opens DOCUframe database
Parameters
| Name |
Description |
Data Type |
RASServerName |
Remote access server name |
xml:string |
ServerName |
Server name |
xml:string |
DatabaseName |
Database name |
xml:string |
UserName |
User name |
xml:string |
UserPassword |
User password, encrypted with MD5 |
xml:string |
SessionTimeOut |
Session timeout |
xml:int |
In case of valid user credentials, method returns ID of the newly created session
Response
| Name |
Description |
Data Type |
SessionID |
ID of the created session |
xml:string |
In case of invalid user credentials method returns status `403 - Forbidden`
In case of server error method returns status `500 - Internal Server Error`
CheckRASServer
Method that checks remote access server
Parameters
| Name |
Description |
Data Type |
RASServerName |
Remote access server name |
xml:string |
Timeout |
Method timeout |
xml:int |
Reponse
| Name |
Description |
Data Type |
CheckRASServerResult |
Result of the method |
xml:string |
ExecuteDocuframeRequest
Method that executes given DOCUframe macro
Parameters
| Name |
Description |
Data Type |
SessionID |
ID of the current session |
xml:string |
RequestName |
Name of the DOCUframe macro to be executed |
xml:string |
Input |
Input for the DOCUframe macro |
xml:string |
Response
| Name |
Description |
Data Type |
Output |
Output from the DOCUframe request |
xml:string |
GetDocuframeDBConnectionsCount
Method that returns database connections count
Parameters
| Name |
Description |
Data Type |
|
|
|
Response
| Name |
Description |
Data Type |
DBCount |
Number of database connections |
xml:string |
GetSessionCount
Method that returns number of active sessions
Parameters
| Name |
Description |
Data Type |
|
|
|
Response
| Name |
Description |
Data Type |
SessionCount |
Number of active sessions |
xml:string |
CloseAllDocuframeDBConnections
Method that closes all DOCUframe database connections
Parameters
| Name |
Description |
Data Type |
SessionID |
ID for the session to close |
xml:string |
Response
| Name |
Description |
Data Type |
OpenedDBs |
Value indicates the number of still opened database connections |
xml:int |
Close
Method that closes session with ID provided as input parameter
Parameters
| Name |
Description |
Data Type |
SessionID |
ID for the session to close |
xml:string |
Response
| Name |
Description |
Data Type |
OK |
Indicates if session has been closed |
xml:boolean |
CloseResult |
Indicates if there are close results |
xml:boolean |