beautypg.com

3 alarm notifier soap interface, 1 using the list function on an alarm notifier, Alarm notifier soap interface -4 – Echelon i.LON SmartServer 2.0 User Manual

Page 96: Using the list function on an alarm notifier -4, Alarm notifier soap interface

background image

i.LON SmartServer 2.0 Programmer’s Reference

7-4

7.3

Alarm Notifier SOAP Interface

You can use the SOAP interface to perform the following functions on an Alarm Notifier application:

Function Description

List

Generate a list of the Alarm Notifiers that you have added to the
SmartServer.

Get

Retrieve the configuration of any Alarm Notifier that you have added
to the SmartServer.

Set

Create a new Alarm Notifier, or overwrite the configuration of an
existing Alarm Notifier.

Read

Read a portion or all of the entries stored in a Alarm Notifier log file.

Write

Acknowledge an alarm notification or a group of alarm notifications.
You can optionally insert comments into the log entry for each alarm
notification with this function.

Clear

Remove a portion or all of the log entries stored in an Alarm Notifier
log file.

Delete

Delete an Alarm Notifier.

7.3.1

Using the List Function on an Alarm Notifier

Use the List function to retrieve a list of the Alarm Notifiers that you have added to the SmartServer.
The List function takes an element that includes an xSelect statement querying items of a
UFPTalarmNotifier_Cfg type as its input, as shown in the example below. The List function returns
an element for each Alarm Notifier that you have added to the SmartServer. The next section
describes the properties included in each of these elements.

You could use the list of elements returned by this function as input for the Get function. The
Get function would then return the configuration of each Alarm Notifier included in the list.

Request



//Item[@xsi:type="UFPTalarmNotifier_Cfg"]


Response




Net/LON/iLON

App/Alarm

Notifier[0]

#8000010128000000[4].UFPTalarmNotifier;xsi:type=“LON_Fb_Cfg”
0