HolidayDayInfo

Represents a set of holidays that may be applied as an override for a given schedule

Once you define a holiday date, it will be applied across all schedules (Making them inactive on the day of the holiday). Each holiday date will belong to one or more Type (1 to 8) types. A holiday date can be marked as special holiday which means “Special Holiday mode is a new mode that does not affect normal day-of-week based time zones and is not disruptive to normal access rights. When a special holiday is active, it allows additional time intervals to be active, as well as the regular day of week time zones to be active. It simply allows the application to define time intervals that will become active only on designated days.”

When defining a schedule duration, the duration can set an exception to one or more types. This means that the schedule will become active during the holiday.

HolidayDayInfo Properties

Item -> BaseInfo -> HolidayDayInfo

Field Type Inherited from Description
Href String Item Gets or sets the href.
CommonName String BaseInfo Common Name of the resource.The common name of the resource.
InFolderHref String BaseInfo relative path Href value for the containing folderAll objects exist within a folder. Even folders!
InFolderKey String BaseInfo Represents the internal ID of the containing folder
IsGlobal Boolean BaseInfo If set True, the object will be exposed to the entire instance scope in which it resides. Meaning this object will always pass scope wide permissions tests when being queried although other restrictions such as by type will still apply (You need at least Read on the object type to see it regardless where you are in the instance scope). This Attribute is intended for use with AccessLevelInfo objects only. Use with other model objects may cause unexpected behaviors. Particularly this should not be used with ScheduleInfos, HolidayInfos, HolidayDayInfos, or ElevatorAccessLevelInfos. In time more objects will be allowed for use with this attribute but for the time being please only use with AccessLevelInfo Objects.
Key String BaseInfo Represents the internal ID of the object.
Links List<Link> BaseInfo List of related resourcesIt is expected that a resource will have many related resources (i.e. person has many access levels) Consumers of the API are encouraged to iterate through the list of links requesting this additional information as required.
Metadata MetadataItem[] BaseInfo The set of metadata attached to this resourceMetadata is opaque to the server code. Key value pairs are saved as part of a client activity. Users of the Native windows client, are able to design custom forms to display and edit scalar values in the meta data.
Monikers MonikerItem[] BaseInfo the set of Monikers for this object
Notes NoteInfo[] BaseInfo The set of notes attached to this resourceNotes are free form text only that is stored in chronological order. All notes are retrieved as part of an OBJECT get. Notes may be added as one POST but not updated with a PUT of the primary resource. WHen the resource is deleted all the notes are also deleted.
ObjectLinks ObjectLinkItem[] BaseInfo The set of resources that are related to this resourceFrequently resources have a one to one, or one to many relationship with other resources in the system. Use this set of links to discover related resources. 2016/09/29 Href property of the related resource may be null. In which case it’s expected that a set of related objects has already been retrieved by the client and the Key value will be used to index into that set.
Tags String[] BaseInfo the set of tags for this objectTags are used to group objects together for the purposes of selection and assignment of operation rights
DayOfHoliday DateTime HolidayDayInfo The specific starting date of the holiday.Only the Date portion of the DateTime value is observed.
ForDays Int32 HolidayDayInfo This will extend the holiday for the amount of days specified. If 1 is entered here it will be a two day holiday. If you would like it to be a 1 day holiday then place 0 here.A valid value must be: 0 <= value <= 127.
HolidayExceptionType HolidayExceptionTypes HolidayDayInfo The type of holiday set or group to add the holiday to. This is used as an exception or even on attribute on a schedule.
IsMaster Boolean HolidayDayInfo If set this holidayday can be subscribed to by child instances (possibly crossing the VAR / Enterprise barrier - see MasterHolidayOptIn InstanceSetting).
IsSpecialDay Boolean HolidayDayInfo This will allow the holiday to enable a schedule for a specified day.

JSON Structure of HolidayDayInfo

{
   "Href"	:	"String",
   "CommonName"	:	"String",
   "InFolderHref"	:	"String",
   "InFolderKey"	:	"String",
   "IsGlobal"	:	"Boolean",
   "Key"	:	"String",
   "Links"	:	"List\<[Link](/object-model/link)\>",
   "Metadata"	:	"[MetadataItem](/object-model/metadataitem)[]",
   "Monikers"	:	"[MonikerItem](/object-model/monikeritem)[]",
   "Notes"	:	"[NoteInfo](/object-model/noteinfo)[]",
   "ObjectLinks"	:	"[ObjectLinkItem](/object-model/objectlinkitem)[]",
   "Tags"	:	"String[]",
   "DayOfHoliday"	:	"DateTime",
   "ForDays"	:	"Int32",
   "HolidayExceptionType"	:	"[HolidayExceptionTypes](/object-model/holidayexceptiontypes)",
   "IsMaster"	:	"Boolean",
   "IsSpecialDay"	:	"Boolean"
}

Add Holiday Day Async

Example in C#

// Returns: HolidayDayInfo
var holidayDayInfo = await client.AddHolidayDayAsync(FolderInfo folder, HolidayDayInfo item)

Example in CURL



           curl -X POST \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/holidaydays \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -D '{
                       "$type":"Feenics.Keep.WebApi.Model.HolidayDayInfo, Feenics.Keep.WebApi.Model",
                       "DayOfHoliday":"0001-01-01T00:00:00",
                       "ForDays":0,
                       "IsSpecialDay":false,
                       "HolidayExceptionType":0,
                       "Key":null,
                       "CommonName":"AddHolidayDay",
                       "InFolderHref":null,
                       "InFolderKey":null,
                       "Links":[],
                       "ObjectLinks":null,
                       "Metadata":null,
                       "Notes":null,
                       "Tags":null,
                       "Monikers":null,
                       "Href":null
                   }'
            

Delete Holiday Day Async

Example in C#

// Returns: nothing
await client.DeleteHolidayDayAsync(HolidayDayInfo holidayDay)

Example in CURL



           curl -X DELETE \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/holidaydays/HOLIDAYDAY.KEY \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' 
            

Get Holiday Days Async

Example in C#

// Returns: IEnumerable<HolidayDayInfo>
var holidayDayInfo = await client.GetHolidayDaysAsync(FolderInfo folder)

Example in CURL



           curl -X GET \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/holidaydays \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' 
            

Get Master Holiday Days Async

Example in C#

// Returns: IEnumerable<HolidayDayInfo>
var holidayDayInfo = await client.GetMasterHolidayDaysAsync(FolderInfo folder)

Example in CURL



           curl -X GET \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/holidaydays/master \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' 
            

Holiday2 Opt In Async

Example in C#

// Returns: nothing
await client.Holiday2OptInAsync(InstanceInfo instance)

Example in CURL



           curl -X PUT \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/holiday2optin \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -D '{"$type":"<>f__AnonymousType5, Feenics.Keep.WebApi.Wrapper"}'
            

Subscribe To Master Holiday Day Async

Example in C#

// Returns: HolidayDayInfo
var holidayDayInfo = await client.SubscribeToMasterHolidayDayAsync(FolderInfo folder, HolidayDayInfo masterHolidayDay)

Example in CURL



           curl -X POST \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/holidaydays/subscribe \
               -H 'Authorization: Bearer TOKEN_GOES_HERE'
               -d 'MASTER_HOLIDAYDAY.KEY'
            

Update Holiday Day Async

Example in C#

// Returns: nothing
await client.UpdateHolidayDayAsync(HolidayDayInfo holidayDay)

Example in CURL



           curl -X PUT \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/holidaydays/HOLIDAYDAY.KEY \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -D '{
                       "$type":"Feenics.Keep.WebApi.Model.HolidayDayInfo, Feenics.Keep.WebApi.Model",
                       "DayOfHoliday":"0001-01-01T00:00:00",
                       "ForDays":0,
                       "IsSpecialDay":false,
                       "HolidayExceptionType":0,
                       "Key":"HOLIDAYDAY.KEY",
                       "CommonName":"AddHolidayDay",
                       "InFolderHref":"/api/f/INSTANCE.KEY",
                       "InFolderKey":"INSTANCE.KEY",
                       "Links":[],
                       "ObjectLinks":null,
                       "Metadata":[],
                       "Notes":[],
                       "Tags":[],
                       "Monikers":[],
                       "Href":"/api/f/INSTANCE.KEY/holidaydays/HOLIDAYDAY.KEY"}'