4 using the read function on a calendar, Using the read function on a calendar -13, Using the read function on a calendar – Echelon i.LON SmartServer 2.0 User Manual
Page 163

i.LON SmartServer 2.0 Programmer’s Reference
10-13
<UCPTname>Net/LON/iLON
App/Calendar</UCPTname>
<UCPTdescription>enter an optional description</UCPTdescription>
<ScheduleEffectivePeriod
xsi:type="UFPTscheduler_CfgEffectivePeriod">
<StartDate>2000-01-01</StartDate>
<EndDate>2037-12-31</EndDate>
</ScheduleEffectivePeriod>
<Exception>
<UCPTindex>3</UCPTindex>
<UCPTexceptionName>RecurringWeekendException</UCPTexceptionName>
<UCPTaliasName>Recurring
Weekend
Exception</UCPTaliasName>
<UCPTtemporary>0</UCPTtemporary>
<Schedule>
<StartDate
xsi:type="UFPTcalendar_CfgESDate">
<UCPTdate>2008-03-06</UCPTdate>
<UCPTyearMask
xsi:type="string"
LonFormat="UCPTyearMask">DW_NUL</UCPTyearMask>
<UCPTmonthMask
xsi:type="string"
LonFormat="UCPTmonthMask">DW_NUL</UCPTmonthMask>
<UCPTdayMask
xsi:type="string"
LonFormat="UCPTdayMask">DW_NUL</UCPTdayMask>
</StartDate>
<EndDate
xsi:type="UFPTcalendar_CfgESDate">
<UCPTdate>2037-12-31</UCPTdate>
<UCPTyearMask
xsi:type="string"
LonFormat="UCPTyearMask">DW_WILDCARD
</UCPTyearMask>
<UCPTmonthMask
xsi:type="string"
LonFormat="UCPTmonthMask">DW_WILDCARD
</UCPTmonthMask>
<UCPTdayMask
xsi:type="string"
LonFormat="UCPTdayMask">DW_WILDCARD</UCPTdayMask>
</EndDate>
<UCPTschedDay
xsi:type="string"
LonFormat="UCPTschedDay">DM_EVERY_WEEKEND_DAY
</UCPTschedDay>
<UCPTschedMonth
xsi:type="string"
LonFormat="UCPTschedMonth">MN_NUL</UCPTschedMonth>
</Schedule>
</Exception>
</Item>
</iLonItem>
</Set>
Response
<SetResponse xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/"><iLonItem >
<UCPTfaultCount>0</UCPTfaultCount>
<Item>
<UCPTname>Net/LON/iLON
App/Calendar__TEMP_OBJECT</UCPTname>
</Item>
</iLonItem>
</SetResponse>
10.3.4
Using the Read Function on a Calendar
You can use the Read function to retrieve the events scheduled in the exceptions on a Calendar on the
SmartServer. Optionally, you can filter events using an xSelect statement and specifying one or more
Calendar items. If you do not filter the results with an xSelect statement, the Read function returns the
first 50 events in the selected calendar starting from January 1
st
, 2000.
You can use the following filters in an xSelect statement when using the Read function on a Calendar:
UCPTlastUpdate
When an event occurs. You can compare the specified start and stop
times using equal, less (or equal), great (or equal). UCPTstop is set
to time of last shown event. You need to check whether UCPTstop
differs from UCPTlastUpdate to make the next request start from the
UCPTstop time.
UCPTexeptionName
The name of the exception in which the events are scheduled.