Get Report Details (ivnGetReportDetails)
|
§ |
This webservice is invoked to retrieve the report details of a given report of a company in Intelliview NXT. |
|
§ |
User requires “Author/Editor/Viewer” privilege (User parameter in ivnInitialize) for the execution of this API. |
Web Service Request:
public string ivnGetReportDetails (string SessionToken, int CompanyID, string ReportName)
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 |
|
|
ReportName |
String |
Report Name in Intelliview NXT. |
|
Web Service Response (Success):
<ResponseMessage>
<ReportDetailsList/>
< Report ID='23' ReportName='Sales Report' ReportType='6' ReportFolderName='My Reports'/> < Report ID='22' ReportName='HR Report' ReportType='10' ReportFolderName='HR'/> </ReportDetailsList>
<UserID='12'/>
<Company ID='23'/>
<Version No='1.3.1.1'/>
</ResponseMessage>
Web Service Response (Error):
<ResponseMessage>
<Message ID='SYN_REP_ERROR_7576'/>
<Response Message= 'Report name 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 |
|
|
ReportName |
String |
Report Name in Intelliview NXT. |
|
|
ReportType |
Integer |
Report Type in Intelliview NXT |
Valid Values: |
|
Foldername |
String |
Folder in which report is located. |
|
|
Message ID |
String |
The unique Identification assigned to a |
|
|
Response Message |
String |
The unique Identification assigned to a |
|
|
Company ID |
Integer |
The unique Identification assigned to |
|
|
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 |
|
3 |
SYN_REP_ERROR_7511 |
Company ID is not valid |
|
4 |
SYN_REP_ERROR_7576 |
Report name is not valid |
|
5 |
SYN_REP_INFO_7577 |
No report is available |
<< Set UI Element Status (ivnSetUIElementStatus) | Get Sub Report Details (ivnGetSubReportDetails) >>