Get Data Model Field List (ivnGetDataModelFields)

 

§

This web service is invoked to retrieve the list of fields in the result set of a data model. This will be applicable only for data models defined as a query in Intelliview NXT.

§

This API is primarily invoked to get the list of fields in a data model while defining an Implicit Filter.

§

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

Web Service Request:

public string ivnGetDataModelFields(string SessionToken, int CompanyID, int DataModelID)

Web Service Request Parameters:

Parameters

Data Type

Description

Remarks

SessionToken

String

The unique Identification assigned to the
Intelliview NXT Session

 

CompanyID

Integer

The unique Identification assigned to the
Company in Intelliview NXT.

 

DataModel ID

Integer

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

 

Web Service Response (Success):

<ResponseMessage>

<DataModelFields>

<Data FieldName='ProductName' />

<Data FieldName='ProductCategory' />

<Data FieldName='CustomerName' />

<Data FieldName='CustomerState' />

</DataModelFields>

<DataModel ID='1'/>

<Company ID='23' />

<Version No='1.3.1.1'/>

</ResponseMessage>

Web Service Response (Error):

<ResponseMessage>

<Message ID='SYN_REP_ERROR_7511'/>

<Response Message= 'Company ID is not valid'/>

<Company ID='23'/>

<Version No='1.3.1.1'/>

</ResponseMessage>

Web Service Return Parameters:

Parameters

Data Type

Description

Requirement

DataModel ID

Integer

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

 

FieldName

String

Name of the field in the Datamodel

 

Message ID

String

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

Returned on error;

Response Message

String

The Response Message is received
from Intelliview NXT.

Returned on error; Only English
Language is supported in the
current version.

Company ID

Integer

The unique Identification assigned to
the Company by Intelliview NXT.

 

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

3

SYN_REP_ERROR_7511

Company ID is not valid

4

SYN_REP_ERROR_7522

Datamodel ID is not valid

 

 

top.jpg

 

<< Get Implicit Filter details (ivnGetImplicitFilterDetails)