Show a Widget (ivnShowWidget)
|
§ |
This webservice is invoked to display a widget for a given Report and sub-report defined in Intelliview NXT. |
|
§ |
User requires “Author/Editor/Viewer” privilege (User parameter in ivnInitialize) for the execution of this API. |
Web Service Request:
public string ivnShowWidget(string SessionToken, int CompanyID, int ReportID, string SubReportName, string WidgetName, string ExtraParam)
Web Service Request Parameters:
|
Parameters |
Data Type |
Description |
Requirement |
|
SessionToken |
String |
The unique Identification assigned to a Intelliview |
|
|
CompanyID |
Integer |
The unique Identification assigned to a Company in |
|
|
Report ID |
Integer |
The unique Identification assigned to the Report in |
|
|
SubReportName |
String |
The name of the sub-report defined in a Report |
|
|
WidgetName |
String |
The name of the widget |
|
|
ExtraParam |
String |
Additional Parameter (future use) |
Web Service Response (Success):
<iframe
src='http://10.50.17.63/ZFC1.3/Dashboards/IntegrateDashboard.aspx?Company=Pinnacle&Dashboard= Test1&FilterDoc=xzvsm445vneqct45kqifkpzu.xml&filtertoolbar=1&reporttoolbar=1&widgettoolbar=1& WidgetName=w1' frameborder="0" width="100%" height="100%" />
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 |
|
ResponseMessage |
String |
Response Message for the Web Service Request. |
Returned on error; |
|
Message ID |
String |
Response Message ID for the Web Service |
Returned on error; |
|
Company ID |
Integer |
The unique Identification assigned to the |
Returned on error; |
|
Version |
String |
The last digit after the third decimal point indicates |
Returned on error; |
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_ERROR_7585 |
Subreport name is not valid |
|
6 |
SYN_REP_ERROR_7586 |
Widget name is not valid |
<< Get Widget Details (ivnGetWidgetDetails) | Show a Report (ivnShowReport) >>