Perfion Web Service Interface

Web method signature

string GetData( string queryParameters );

Query parameters structure

<RemoteQuery name='QueryName' group='All' type='Cluster' localizable='true'>

<!-- List of Fields to return -->

<Field name='Key'/>

<Field name='Variant'/>

<Field name='Price'/>

<Field name='Currency'/>

<!-- List of Parameter names with values -->

<Parameter id='PriceDate'>2010-07-29</Parameter>

<Parameter id='Factor'>1.5</Parameter>

<!-- List of Key values -->

<Key>1</Key>

<Key>2</Key>

<Key>...</Key>

<Key>N</Key>

<!-- List of Variants -->

<Variant>DKK-Ret</Variant>

<Variant>DKK-Net</Variant>

<Variant>EUR-Ret</Variant>

<Variant>EUR-Net</Variant>

<!-- Languages -->

<Languages>EN,DE,DAN</Languages>

</RemoteQuery>

Parameter name

Required

Options

Description

Remote

Query

Yes

-

Root element, which must have four attributes: name, group,

type and localizable

name

Yes

-

RemoteQuery attribute specifying query name.

group

Yes

“All”,

“None”,

<user defined>

RemoteQuery attribute specifying query group name. It specifies which part of query should be executed. Groups “All” and “None” must be supported and user defined groups are optional.

type

Yes

Single, Cluster

RemoteQuery attribute specifying remote data type.

• Single. The query returns only one row for each key value.

• Cluster. The query can return multiple rows for each key value, where each will be distinguished by variant.

localizable

No

True, False

RemoteQuery attribute specifying if returned data must be in a special format used with localizable features. Default value is “False” if parameter is not defined.

Field

No

-

It is the data field (data header or data column name) requested by the query. The name of the field is specified in “name” attribute. Query must return only the data fields specified by field elements.

The field elements are optional. If they are not defined, then the query must return all available data fields.

Field names are case insensitive.

There are several reserved field names, which have special meaning in Perfion and can only be used to return specific data:

• Key or KeyValue. This field name is reserved for data fields with unique key values of the items to be returned by the query. This field is used to map Perfion data and data available in remote data source. “Key” and “KeyValue” data field names are aliases and both cannot exist in the same data response from the web service. For example, if “Key” is used, then “KeyValue” cannot be used, and vice versa.

• Variant. This field name is reserved to be used with Cluster type queries and the data field with this name will be used to return variant values for items to be returned by the query. If variant data is used, then data specified in “Key” data field and “Variant” data field must be unique, e.g. for each key value, there should be only unique variant values.

Parameter

No

-

It specifies parameter values used in query. The name of the parameter is specified in “id” attribute and are case insensitive. Parameters are optional. The values must be of data type specified by the GetQueryInfo web method.

Key

Yes

-

It specifies a unique value of the item to be returned by the query. There can be multiple keys specified, but they must be all unique.

Variant

Yes

-

It specifies a list of variant values to be returned by the query for each key value.

Variants will be used only with Cluster type data. In any other cases variants are optional and if used, it can be used as a simple parameter with multiple values.

Languages

Yes

<Language codes supported by Perfion>

It is a special parameter and specifies the list of language codes used by Perfion based on context where remote data will be used. The languages may differ based on where from data was requested. For example, if Perfion will show data only using English language (e.g. in the grid), then it will specify “EN” language code. If it will show data using multiple languages (e.g. in Item Editor), then multiple language codes will be sent, e.g. “EN,DE,DAN”.

This parameter is optional. Perfion will always send it, but it may be ignored in most cases except if query is specified as localizable. If query is localizable, then data must be prepared in a special format, suitable to be used with localizable remote features.

Return data format

<RemoteQueryData>

<xs:schema id="RemoteQueryData" xmlns=""

xmlns:xs="http://www.w3.org/2001/XMLSchema " xmlns:msdata="urn:schemas- microsoft-com:xml-msdata">

<xs:element name="RemoteQueryData"

msdata:IsDataSet="true" msdata:UseCurrentLocale="true">

<xs:complexType>

<xs:choice minOccurs="0" maxOccurs="unbounded">

<xs:element name="Data">

<xs:complexType>

<xs:sequence>

<xs:element name="Key" type="xs:string" minOccurs="0"/>

<xs:element name="Variant" type="xs:string" minOccurs="0" />

<xs:element name="Price" type="xs:double" minOccurs="0" />

<xs:element name="Currency" type="xs:string" minOccurs="0" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:choice>

</xs:complexType>

</xs:element>

</xs:schema>

<Data>

<Key>1</Key>

<Variant>DKK-Ret</Variant>

<Price>125.5</Price>

<Currency>DKK</Currency>

</Data>

<Data>

<Key>1</Key>

<Variant>EUR-Ret</Variant>

<Price>16.87</Price>

<Currency>EUR</Currency>

</Data>

<Data>

<Key>1</Key>

<Variant>DKK-Net</Variant>

<Price>130.3</Price>

<Currency>DKK</Currency>

</Data>

<Data>

<Key>1</Key>

<Variant>EUR-Net</Variant>

<Price>17.51</Price>

<Currency>DKK</Currency>

</Data>

…

</RemoteQueryData>

Web method signature

string GetQueries();

Return data format

<RemoteQueries>

<Query   name='<QueryName1>'   type='<QueryType1>'/>

<Query   name='<QueryName2>'   type='<QueryType2>'/>

…

<Query name='<QueryNameN>' type='<QueryTypeN>'/>

</RemoteQueries>

Web method signature

string GetQueryInfo( string queryName );

Return data format

<RemoteQueryInfo>

<Parameter name='PriceDate' type='Date'/>

<Parameter name='Factor' type='Number'/>

<Parameter name='Currency' type='String'/>

<Group name='All'/>

<Group name='None'/>

<Group name='Cars'/>

<Group name='Movies'/>

<Group name='Doors'/>

</RemoteQueryInfo>