› Web services interface for Kofax Monitor › KC Plug-In › GetConnection function

GetConnection function

This function returns the status of a connection between KC Plug-In and Message Connector.


getconnection function

On success, the function returns the status of the specified connection.


response to getconnection function

The ConnectionState values are defined in the following table.

Value

Description

-1

Connection is active but not connected.

0

Connection is inactive.

1

Connection is active and connected.

Example: 

<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <GetConnectionResponse xmlns="http://www.kofax.com/2011/KIC-ElectronicDocuments">
    <ConnectionState>-1</ConnectionState>
  </GetConnectionResponse>
</s:Body>