GSD NETframe SOAP Actions - /Webservice.asmx

WSDL for this route is available under /Webservice.asmx?wsdl

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 DEPRECATED Read timeout (only Net-Frame 1.6). xml:int

Response

Name Description Data Type
OpenDocuframeDBResult Return code for session login xml:string
SessionID ID of the created session if success xml:string

Return Codes

Value Description
200 Login successful
400 Bad Request - Provided RAS is not configured
403 Invalid user credentials
500 Internal Server Error

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
ExecuteDocuframeRequestResult Return code xml:int
Output Output from the DOCUframe request xml:string

Return codes

Value Description
200 Request executed successfully
403 Invalid session
500 Internal server error

CheckRASServer

Method that checks remote access server

Parameters

Name Description Data Type
RASServerName Remote access server name. xml:string
Timeout Timeout after host probe times out (milliseconds). xml:int

Reponse

Name Description Data Type
CheckRASServerResult JSON string status. xml:string

CheckRASServerResult example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
    "message": "Successful check for RAS 127.0.0.1",
    "status": [
        {
            "port": 54332,
            "status": "OK"
        },
        {
            "port": 60010,
            "status": "TIMEOUT"
        },
        {
            "port": 123,
            "status": "ERROR"
        }
    ],
    "code": 200
}

Return codes

Value Description
200 Check executed successfully
400 RAS Server does not exist in config
500 Internal server error

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