Get Widget Details (ivnGetWidgetDetails)
|
§ |
This webservice is invoked to retrieve the details of the widgets for a given Report and sub-report in Intelliview NXT. |
|
§ |
User requires “Author/Editor/Viewer” privilege (User parameter in ivnInitialize) for the execution of this API. |
Web Service Request:
public string ivnGetWidgetDetails (string SessionToken, int CompanyID, int ReportID, string SubReportName)
Web Service Request Parameters:
|
Parameters |
Data Type |
Description |
Requirement |
|
SessionToken |
String |
The unique Identification assigned to a |
|
|
CompanyID |
Integer |
The unique Identification assigned to a |
|
|
Report ID |
Integer |
The unique Identification assigned to the |
|
|
SubReportName |
String |
Sub Report Name |
Mandatory |
Web Service Response (Success):
<ResponseMessage>
<ReportID='23'/>
<SubReportName='APAC Sales'/>
<WidgetDetails>
<WidgetID ='1' WidgetName='APAC Sales by Product' /> <WidgetID ='2' WidgetName='APAC Sales by Sales Person' />
</WidgetDetails>
<Company ID='23'/>
<Version No='1.3.1.1'/>
</ResponseMessage>
Web Service Response (Error):
<ResponseMessage>
<Message ID='SYN_REP_ERROR_7530'/>
<Response Message= 'Report ID is not valid'/>
<Company ID='23'/>
<Version No='1.3.1.1'/>
</ResponseMessage>
Web Service Return Parameters:
|
Parameters |
Data Type |
Description |
Remarks |
|
Report ID |
Integer |
The unique Identification assigned to the |
|
|
SubReportName |
String |
The name of the sub-report defined in a Report |
|
|
WidgetID |
Integer |
The unique Identification assigned to the |
|
|
WidgetName |
String |
The name of the widget |
|
|
Message ID |
String |
The unique Identification assigned to a |
Returned on error; |
|
|
|
Resource in Intelliview NXT. |
|
|
Response Message |
String |
The unique Identification assigned to a |
Returned on error; |
|
Company ID |
Integer |
Unique Identification assigned for the Given |
|
|
Version |
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_7530 |
Report ID is not valid |
|
5 |
SYN_REP_INFO_7584 |
No widget is available |
<< Get Sub Report Details (ivnGetSubReportDetails) | Show a Widget (ivnShowWidget) >>