ScheduleDurationItem

Represents a specific day (or days) that a schedule is active at a specific timeframe.

Schedule Duration Items are added to the ScheduleInfo class to define the day/time intervals.

ScheduleDurationItem Properties

Item -> ScheduleDurationItem

Field Type Inherited from Description
Href String Item Gets or sets the href.
DayMask Int32 ScheduleDurationItem Gets or sets the day mask. ie 62 = 00111110 which enables Monday-Friday (Right to Left)
Duration TimeSpan ScheduleDurationItem Gets or sets the duration. (hh:mm:ss) From StartingAt.
Holiday String ScheduleDurationItem Gets or sets the holiday. OPTIONAL, see HolidayInfo
HolidayExceptions HolidayExceptionTypes ScheduleDurationItem Gets or sets the HolidayExceptions value
StartingAt TimeSpan ScheduleDurationItem Gets or sets the starting at. (hh:mm:ss) From Start of day.

JSON Structure of ScheduleDurationItem

{
   "Href"	:	"String",
   "DayMask"	:	"Int32",
   "Duration"	:	"TimeSpan",
   "Holiday"	:	"String",
   "HolidayExceptions"	:	"[HolidayExceptionTypes](/object-model/holidayexceptiontypes)",
   "StartingAt"	:	"TimeSpan"
}

Add Schedule Duration Async

Example in C#

// Returns: nothing
await client.AddScheduleDurationAsync(ScheduleInfo schedule, ScheduleDurationItem item);

Example in CURL



           curl -X POST \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/schedules/scheduleKey/scheduledurations \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -D '{
                       "$type":"Feenics.Keep.WebApi.Model.ScheduleDurationItem, Feenics.Keep.WebApi.Model",
                       "DayMask"	:	"Int32",
                       "Duration"	:	"TimeSpan",
                       "Holiday"	:	"String",
                       "HolidayExceptions"	:	"[HolidayExceptionTypes](/object-model/holidayexceptiontypes)",
                       "StartingAt"	:	"TimeSpan"
                   }'

Delete Schedule Duration Async

Example in C#

// Returns: nothing
await client.DeleteScheduleDurationAsync(ScheduleInfo schedule, ScheduleDurationItem item);

Example in CURL



           curl -X DELETE \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/schedules/scheduleKey/scheduledurations \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -D '{
                       "$type":"Feenics.Keep.WebApi.Model.ScheduleDurationItem, Feenics.Keep.WebApi.Model",
                       "DayMask"	:	"Int32",
                       "Duration"	:	"TimeSpan",
                       "Holiday"	:	"String",
                       "HolidayExceptions"	:	"[HolidayExceptionTypes](/object-model/holidayexceptiontypes)",
                       "StartingAt"	:	"TimeSpan"
                   }'