Get Data model details (ivnGetDataModelDetails)
§ |
This web service is invoked to retrieve the data model details for a given company and connection in Intelliview NXT. |
§ |
User requires “Admin” privilege (User parameter in ivnInitialize) for the execution of this API. |
Web Service Request:
public string ivnGetDataModelDetails(string SessionToken, int Company ID, int ConnectionID, int DataModelID)
Web Service Request Parameters:
Parameters |
Data Type |
Description |
Remarks |
SessionToken |
String |
The unique Identification assigned to the Intelliview |
|
CompanyID |
Integer |
The unique Identification assigned to the Company |
|
ConnectionID |
Integer |
The unique Identification assigned to the |
|
DataModelID |
Integer |
The unique Identification assigned to the Data |
|
Web Service Response (Success):
<ResponseMessage>
<DataModelDetails>
<DataModel ID ='1' DataModelName ='SalesTrendDM' ConnectionName='SalesDbConn' ScheduleRefreshTimeOption='15' Timeout='0' QueryType='1' QueryText='Select * from PinnacleEmployees' LastRefresh='09/02/2013 17:38:38' NextRefresh='09/02/2013 17:53:38'/>
<DataModel ID ='2' DataModelName ='RegionalSales DM' ConnectionName='SalesDbConn' ScheduleRefreshTimeOption='15' Timeout='0' QueryType='1' QueryText='Select * from PinnacleTransactions' LastRefresh='2013-02-09 18:38:38.807' NextRefresh='2013-02-09
18:53:38.807'/>
</DataModelDetails>
<Company ID='23'/>
<Version No='1.3.1.1'/>
</ResponseMessage>
Web Service Response (Error):
<ResponseMessage>
<Message ID='SYN_REP_ERROR_7522'/>
<Response Message= 'Datamodel ID is not valid'/>
<Company ID='23'/>
<Version No='1.3.1.1'/>
</ResponseMessage>
Web Service Return Parameters:
Parameters |
Data Type |
Description |
Requirement |
DataModelID |
Integer |
The unique Identification assigned to |
|
DataModelName |
String |
Name of the Data Model |
|
ConnectionName |
Integer |
Connection Name |
|
ScheduleRefreshTimeOption |
Integer |
Defines the data refresh interval in |
|
TimeOut |
Integer |
SQL Query Time out |
|
LastRefresh |
Integer |
Last Refresh Date Time |
|
NextRefresh |
String |
Next Refresh Date Time |
|
Message ID |
String |
The unique identification assigned to |
Returned on Error; |
Response Message |
String |
The Response Message is received |
Returned on Error; Only |
Company ID |
Integer |
The unique Identification assigned to |
|
Version |
String |
The last digit after the third decimal |
|
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_7522 |
Data model ID is not valid |
5 |
SYN_REP_ERROR_7556 |
Connection ID is not valid |
6 |
SYN_REP_ERROR_7544 |
No data model available |
<< Update Connection Details (ivnUpdateConnection) | Create Data model (ivnCreateDataModel) >>