Method TestDatabaseConnection
TestDatabaseConnection(String, RequestSettingsContract, DatabaseConnectionContract)
Test database connection
Declaration
RequestResultContract TestDatabaseConnection(string connectionId, RequestSettingsContract requestSettings, DatabaseConnectionContract databaseConnection)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | connectionId | The connection id to identify your connection. See also ConnectionId |
| RequestSettingsContract | requestSettings | Request settings, e.g. Language |
| DatabaseConnectionContract | databaseConnection | Database connection to be tested |
Returns
| Type | Description |
|---|---|
| RequestResultContract | Returns the result of the query |
Examples
PUT http://YourServerName/InfoShare/Json/Invoice/TestDatabaseConnection
Example for testing database connection.Exceptions
| Type | Condition |
|---|---|
| ServiceException | The connection id {connectionId} isn't valid or has expired (10008) |
| ServiceException | Verification code is needed: Verification code not yet verified (10152) |