2 using the get function on a type translator rule, Using the list function on a type translator rule, Using the get function on a type translator rule – Echelon i.LON SmartServer 2.0 User Manual

Page 191

Advertising
background image

i.LON SmartServer 2.0 Programmer’s Reference

13-3

Delete

Delete a type translator rule.

13.3.1

Using the List Function on a Type Translator Rule

You can use the List function to retrieve a list of the Type Translator Rules that you have added to the
SmartServer. The List function takes an <iLonItem> element that includes an xSelect statement
querying items of a UFPTtypeTranslator_Rule_Cfg type as its input, as shown in the example below.
The List function returns an <Item> element for each type translator rule on the SmartServer included
in the specified xSelect statement. The next section describes the properties included in each of these
elements.

Request

<List xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem>
<xSelect>//Item[@xsi:type="UFPTtypeTranslator_Rule_Cfg"]</xSelect>
</iLonItem>
</List>

Response

<ListResponse xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem >

<UCPTfaultCount>0</UCPTfaultCount>
<UCPTcurrentConfig>4.0</UCPTcurrentConfig>
<Item>

<UCPTname>My Custom Rule: SNVT_temp to SNVT_temp_p</UCPTname>

<UCPTannotation>8000010128000000[4].UFPTtypeTranslator_Rule;

xsi:type=“UFPTtypeTranslator_Rule_Cfg”

</UCPTannotation>
<UCPThidden>0</UCPThidden>
</Item>
<Item>

<UCPTname>My Custom Rule: 2xSwitch_to_Switch</UCPTname>

<UCPTannotation>8000010128000000[4].UFPTtypeTranslator_Rule;

xsi:type=“UFPTtypeTranslator_Rule_Cfg”

</UCPTannotation>
<UCPThidden>0</UCPThidden>

</Item>
</iLonItem>
</ListResponse>

13.3.2

Using the Get Function on a Type Translator Rule

You can use the Get function to retrieve the configuration of any type translator rule on the
SmartServer. You must reference the type translator whose configuration is to be returned by its
<UCPTname> in the input you supply to the function, as shown in the example below.

Request

<Get xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem>
<Item>

<UCPTname>My Custom Rule: 2xSwitch_to_Switch</UCPTname>

</Item>

</iLonItem>
</Get>

Response

<GetResponse xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem >

<UCPTfaultCount>0</UCPTfaultCount>

<Item xsi:type="UFPTtypeTranslator_Rule_Cfg" >

<UCPTname>2xSwitch_to_Switch</UCPTname>
<UCPTannotation>8000010128000000[4].UFPTtypeTranslator_Rule</UCPTannotation>
<UCPThidden>0</UCPThidden>
<UCPTlastUpdate>2008-03-13T13:47:47.330-07:00</UCPTlastUpdate>

Advertising