Update Datamodel (ivnUpdateDataModel)

§

This web service is invoked to update a data model that accesses the data using the connection defined in Intelliview NXT.

§

User requires “Admin” privilege (User parameter in ivnInitialize) for the execution of this API.

 Web Service Request:

public string ivnUpdateDataModel(string SessionToken, int CompanyID, int DataModelID, int ScheduleRefreshTimeOption, int TimeOut, string DataModelQuery)

Web Service Request Parameters:

Parameters

Data Type

Description

Remarks

SessionToken

String

The unique Identification
assigned for the Intelliview NXT
Session.

 

CompanyID

Integer

The unique Identification
assigned to the Company in
Intelliview NXT.

 

DataModelID

Integer

The unique Identification
assigned to the Data Model in
Intelliview NXT.

 

ScheduleRefreshTimeOption

Integer

Defines the data refresh interval
in minutes from Reporting data
source to Intelliview NXT

 

TimeOut

Integer

SQL Query Time out

 

DataModelQuery

String

Data Model Query

 

Web Service Response (Success):

<ResponseMessage>

<Message ID='SYN_REP_INFO_7561'/>

<Response Message= 'Datamodel details update is successful'/>

<DatamodelID='6'/>

<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

Remarks

Message ID

String

The unique identification assigned
to the response message in
Intelliview NXT.

 

Response Message

String

The Response Message is received
from Intelliview NXT.

Only English Language is
supported in the current
version.

Datamodel ID

Integer

The unique Identification assigned
to the Data Model in Intelliview
NXT.

Returned on success

Company ID

Integer

The unique Identification assigned

to the Company by Intelliview NXT.

 

VersionNo

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
not valid

3

SYN_REP_ERROR_7511

Company ID is not valid

4

SYN_REP_ERROR_7521

Datamodel query is not valid

5

SYN_REP_ERROR_7522

Datamodel ID is not valid

6

SYN_REP_INFO_7561

Datamodel details update is successful

7

SYN_REP_ERROR_7567

Unable to update Datamodel

 

 

top.jpg

 

<< Create Data model (ivnCreateDataModel) | Get Data model details (ivnGetDataModelDetails) >>