Get Connection Details (ivnGetConnectionDetails)

§

This web service invoked to retrieve the details of the connections defined in Intelliview NXT for a specified

company.

§

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

Web Service Request:

public string ivnGetConnectionDetails(string SessionToken, int CompanyID, string

ConnectionName)

Web Service Request Parameters:

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 in Intelliview NXT.

 

ConnectionName

String

Connection Name

If the value is null, the API
returns all the connection
details for the company

Web Service Response (Success):

<ResponseMessage>

<ConnectionDetails>

<Connection ID='1' ConnectionName='SalesDbConn' ConnectionType='MYSQL' DatabaseServer='213.11.12.23' DatabasePort='9100' DatabaseName='Sales' DatabaseUser='sa' DatabasePassword=' X3EHvlz5QkD2oOcxdFUIcQ==' AuthenticationMethod=/>
<Connection ID='2' ConnectionName='HRDbConn' ConnectionType='DB2' DatabaseServer='213.11.12.23' DatabasePort='50009' DatabaseName='Sales' DatabaseUser='admin' DatabasePassword=' qg9ZeWLKN/WrulxKIzP4Qw=='
AuthenticationMethod='Server'/>

</ConnectionDetails/>

<Company ID='23'/>

<Version No='1.3.1.1'/>

</ResponseMessage>

Web Service Response (Error):

<ResponseMessage>

<Message ID='SYN_REP_ERROR_7512'/>

<Response Message= 'Connection name is not valid'/>

<Company ID='23'/>

<Version No='1.3.1.1'/>

</ResponseMessage>

Web Service Return Parameters:

Parameters

Data Type

Description

Remarks

Connection ID

Integer

The unique Identification assigned to the
Connection in in Intelliview NXT.

 

ConnectionName

String

Connection Name

 

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

 The password is in
3DES encrypted format

AuthenticationMethod

String

Authentication Method

Default value: NULL

 
 
 
 

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

  •  

Server

  •  

Client

  •  

Server Encrypt

  •  

Data Encrypt
DataEncryptcmp

Message ID

String

The unique identification assigned to the

ResponseMessage

String

response message in Intelliview NXT.

Returned on Error.

Company ID

Integer

The Response Message is received
from Intelliview NXT.

Returned on Error. Only
English Language is
supported in the current
version.

Version No

String

Unique Identification of the Company
whose details are to be updated

 

 

 

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

 

Response Messages:

Srl.No.

Message ID

Message

1

SYN_REP_ERROR_5035

Exception has occurred. Contact your Administrator

2

SYN_REP_ERROR_7501

Intelliview NXT session is expired or not initialized or
not valid

3

SYN_REP_ERROR_7511

Company ID is not valid

4

SYN_REP_ERROR_7512

Connection name is not valid

5

SYN_REP_INFO_7582

No connection available

 

 

top.jpg

 

<< Update Connection Details (ivnUpdateConnection) | Create Data model (ivnCreateDataModel) >>