Update Connection Details (ivnUpdateConnection)

§

This web service invoked to update the details of the connection defined to a reporting data source in Intelliview NXT.

§

User requires “Admin” privilege (User parameter in ivnInitialize) for the execution of this API.

Web Service Request:

Web Service Request Parameters:

public string ivnUpdateConnection(string SessionToken, int CompanyID, int ConnectionID, string

ConnectionType, string DatabaseServer, int DatabasePort, string DatabaseName, string
DatabaseUser, string DatabasePassword, string AuthenticationMethod)

Parameters

Data Type

Description

Remarks

SessionToken

String

The unique Identification assigned
for the Intelliview NXT Session

 

CompanyID

Integer

The unique Identification assigned
to the Company by Intelliview NXT.

 

ConnectionID

String

The unique Identification assigned
to the Connection in Intelliview
NXT.

 

ConnectionType

String

Connection Type

 
 
 
 

Valid Values:

  •  

MS SQL

  •  

ORACLE

  •  

DB2

  •  

MYSQL
MYSQLConnector

DatabaseServer

String

Database Server

 

DatabasePort

Integer

Database Port

 

DatabaseName

String

Database Name

 

DatabaseUser

String

Database User ID

 

DatabasePassword

String

Database User Password

 

AuthenticationMethod

String

Authentication Method (Maximum
Length = 500). Default value: Null

 
 
 
 
 

This parameter is only
applicable for DB2
database. Valid Values
for DB2:

  •  

'Server'

  •  

'Client'

  •  

'Server Encrypt'

  •  

'Data Encrypt'

  •  

'DataEncryptcmp'

Web Service Response (Success):

<ResponseMessage>

<Message ID='SYN_REP_INFO_7554'/>

<Response Message= 'Connection details update is successful'/>

<Connection ID='6'/>

<Company ID='23'/>

<Version No='1.3.1.1'/>

</ResponseMessage>

Web Service Response (Error):

<ResponseMessage>

<Message ID='SYN_REP_ERROR_7511'/>

<Response Message= 'Company ID is not valid'/>

<Company ID='23'/>

<Version No='1.3.1.1'/>

</ResponseMessage>

Web Service Return Parameters:

Parameters

Data Type

Description

Remarks

Message ID

String

The unique identification assigned to the

Response Message

String

response message in Intelliview NXT.

Only English Language
is supported in the
current version.

Connection ID

Integer

The Response Message is received
from Intelliview NXT.

Returned on success

Company ID

Integer

The unique Identification assigned to
the Connection in Intelliview NXT.

 

Version No

String

The unique Identification assigned to
the Company by Intelliview NXT.

 

 

 

The last digit after the third decimal
point indicates the web service version

 

 Response Messages:

Srl.No.

Message ID

Message

1

SYN_REP_ERROR_5043

Invalid Connection details

2

SYN_REP_ERROR_5094

Unable to create Connection

3

SYN_REP_ERROR_5035

Exception has occurred. Contact your Administrator

4

SYN_REP_ERROR_7501

Intelliview NXT session is expired or not initialized or
not valid

5

SYN_REP_ERROR_7511

Company ID is not valid

6

SYN_REP_ERROR_7513

Connection Type is not valid

7

SYN_REP_ERROR_7514

Database server is not valid

8

SYN_REP_ERROR_7516

Database name is not valid

9

SYN_REP_ERROR_7517

Database user is not valid

10

SYN_REP_ERROR_7518

Database password is not valid

11

SYN_REP_INFO_7554

Connection details update is successful

12

SYN_REP_ERROR_7556

Connection ID is not valid

13

SYN_REP_ERROR_7559

Authentication Method is not valid

 

 

top.jpg

 

<< Create Connection (ivnCreateConnection) | Get Connection Details (ivnGetConnectionDetails) >>