Set UI Element Status (ivnSetUIElementStatus)

§

This webservice is invoked to set the UI element to visible or hide (UI elements currently supported are Report Toolbar, Filter Toolbar, Widget Toolbar) in Intelliview NXT.

§

User requires “Author/Editor/Viewer” privilege (User parameter in ivnInitialize) for the execution of this API.

Web Service Request:

public string ivnSetUIElementStatus (string SessionToken, int CompanyID, int UIElementType, Boolean Status)

Web Service Request Parameters:


Parameters

Data Type

Description

Remarks

SessionToken

String

The unique Identification assigned
to a Intelliview NXT Session

 

CompanyID

Integer

The unique Identification assigned
to a Company in Intelliview NXT.

 

UIElementType

Integer

User Interface Element Type

Valid Values:
1 Filter Toolbar
2 Report Toolbar
3 Widget Toolbar

Status

Boolean

True: UI element is visible
False: UI element is hidden

 

Web Service Response (Success):

<ResponseMessage>

<Message ID='SYN_REP_INFO_7543'/>

<Response Message= 'UI element status is set successfully'/>

<Company ID='23'/>

<Version No='1.3.1.1'/>

</ResponseMessage>

Web Service Response (Error):

<ResponseMessage>

<Message ID='SYN_REP_ERROR_7545'/>

<Response Message= 'UI element type 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 a Resource in
Intelliview NXT.

 

Response Message

String

The unique Identification assigned to a Resource in
Intelliview NXT.

 

Company ID

Integer

The unique Identification assigned to the Company by
Intelliview NXT.

 

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_7511

Company ID is not valid

4

SYN_REP_INFO_7543

UI element status is set successfully

5

SYN_REP_ERROR_7545

UI element ID is not valid

6

SYN_REP_ERROR_7573

Unable to set UI element status

 

 

top.jpg

 

<< Get UI Element Status (ivnGetUIElementStatus) | Get Report Details (ivnGetReportDetails) >>