Get All Company Details (ivnGetAllCompanyDetails)

§

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

§

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

Web Service Request:

public string ivnGetAllCompanyDetails (string SessionToken)

Web Service Request Parameters:

Parameters

Data Type

Description

Remarks

SessionToken

String

The unique Identification assigned for the
Intelliview NXT Session

 

Web Service Response (Success):

<ResponseMessage>

<CompanyDetails>

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

CreatedOn='09/22/2013 17:38:38' ModifiedOn='09/25/2013 09:56:23' CompanyActiveStatus='True' />
<Company ID='23' CompanyShortName='BuyBazaar' CompanyName='BuyBazaar Ltd' CompanyDescription='Furniture Store' CreatedOn='09/22/2013 17:38:38' ModifiedOn='09/25/2013 09:56:23' CompanyActiveStatus='True' />

<CompanyDetails/>

<Version No='1.3.1.1'/>

</ResponseMessage>

Web Service Response (Error):

<ResponseMessage>

<Message ID='SYN_REP_ERROR_7508'/>

<Response Message= 'User does not have super admin privileges'/>

<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

 

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_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_7508

User does not have super admin privileges

 

top.jpg

 

<< Get Company Details (ivnGetCompanyDetailsByID)