Get UI Element Status (ivnGetUIElementStatus)
§ |
This webservice is invoked to get the whether UI element is visible or hidden (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 ivnGetUIElementStatus(string SessionToken, int Company ID, int UIElementType)
Web Service Request Parameters:
Parameters |
Data Type |
Description |
Remarks |
SessionToken |
String |
The unique Identification assigned |
|
CompanyID |
Integer |
The unique Identification assigned |
|
UIElementType |
Integer |
User Interface Element Type |
Valid Values: |
Web Service Response (Success):
<ResponseMessage>
<UIElementStatus/>
<UIElement Type= '1' Status= 'True' />
<UIElement Type='2' Status= 'True' />
<UIElement Type='3' Status= 'True' />
</UIElementStatus>
<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 |
UIElementType |
Integer |
User Interface Element Type |
Valid Values: |
Status |
Boolean |
True: UI element is visible |
|
Message ID |
String |
The unique Identification assigned to a |
Returned on error; |
Response Message |
String |
The unique Identification assigned to a |
Returned on error; |
Company ID |
Integer |
The unique Identification assigned to the |
|
Version No |
String |
The last digit after the third decimal point |
|
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 |
3 |
SYN_REP_ERROR_7511 |
Company ID is not valid |
4 |
SYN_REP_ERROR_7545 |
UI element type is not valid |
Set UI Element Status (ivnSetUIElementStatus) >>