Get Company Details (ivnGetCompanyDetailsByID)

§

This web service is invoked to retrieve the details of the Company in Intelliview NXT system.

§

User requires “Super Admin privilege (User parameter in ivnInitialize) for invoking this API.

 Web Service Request:

public string ivnGetCompanyDetailsByID (string SessionToken, int CompanyID)

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

 

Web Service Response (Success):

<ResponseMessage>

<CompanyDetails>

<Company ID='23' CompanyShortName='Pinnacle' CompanyName='Pinnacle' CompanyDescription='Electronic Store'

CreatedOn='09/02/2013 17:38:38' ModifiedOn='09/02/2013 09:56:23' CompanyActiveStatus='True' />
<ConnectionList>

<Connection ID='1' ConnectionName='SalesDatabase' ConnectionType=MYSQL' />
<Connection ID='2' ConnectionName='PinnacleDatabase' ConnectionType='ORACLE' />
<ConnectionList />

<AdminUserDetails>

<User ID='3' UserName='admin' FirstName='Bill' LastName='Roy' EmailID='admin@synaptris.com' PhoneNo='1234567890'/>

</AdminUserDetails>

<CompanyDetails/>

<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

Company ID

Integer

The unique Identification assigned
to the Company by Intelliview NXT.

 

CompanyShortName

String

Company Short Name

 

CompanyName

String

Company Name

 

CompanyDescription

String

Company Description

 

CreatedOn

Date

Date on which the company was
created (Date and Time are
displayed)

 

ModifiedOn

Date

Date on which the company was
last modified (Date and Time are
displayed in the default format)

 

CompanyActiveStatus

Boolean

Status of the Company
True = Active;
False= Deactivate

 

Connection ID

Integer

The unique identification assigned
to the Connection by Intelliview
NXT

 

ConnectioName

String

Connection name to the data
source

 

ConnectionType

String

Indicates the database type to
which connection points to

 
 
 
 

Valid Values:

  •  

MS SQL

  •  

ORACLE

  •  

DB2

  •  

MYSQL
MYSQLConnector

User ID

Integer

The unique identification assigned
to the Admin user of the company
in Intelliview NXT

 

UserName

String

Login User Name

 

FirstName

Sting

First Name of the Admin User

 

LastName

String

Last Name of the Admin User

 

EmailID

String

Email id of the admin user

 

PhoneNo

String

Phone Number of the Admin user

 

Message ID

String

The unique identification assigned
to the response message in
Intelliview NXT.

Returned on Error.

ResponseMessage

String

The Response Message is received
from Intelliview NXT.

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

Version No

String

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

 

Response Messages:

Srl.No.

Message ID

Message

1

SYN_REP_ERROR_7501

Intelliview NXT session is expired or not initialized or
not valid

2

SYN_REP_ERROR_7508

User does not have super admin privileges

3

SYN_REP_ERROR_7511

Company ID is not valid

4

SYN_REP_ERROR_5035

Exception has occurred. Contact your Administrator

 

 

top.jpg

 

<< Get Company Details (ivnGetCompanyDetails) | Get All Company Details (ivnGetAllCompanyDetails) >>