HolidayTypesConfiguration

The intent of this feature is to be able to apply custom names to the holiday exception types.

Please note you will have to manually map the configuration names to the exceptions in which ever app you are creating.

The api will create an array of 8 strings for every instance that defaults to:

  • Holiday Group 1
  • Holiday Group 2
  • Holiday Group 3
  • Holiday Group 4
  • Holiday Group 5
  • Holiday Group 6
  • Holiday Group 7
  • Holiday Group 8

HolidayTypesConfiguration Properties

HolidayTypesConfiguration

Field Type Inherited from Description
TypeNames String[] HolidayTypesConfiguration Gets or sets the TypeNames value

JSON Structure of HolidayTypesConfiguration

{
   "TypeNames"	:	"String[]"
}

Get Holiday Types Configuration Async

Example in C#

// Returns: HolidayTypesConfiguration
var holidayTypesConfiguration = await client.GetHolidayTypesConfigurationAsync(InstanceInfo instance);

Example in CURL



           curl -X GET \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/holidaytypesconfiguration \
               -H 'Authorization: Bearer TOKEN_GOES_HERE''

Set Holiday Types Configuration Async

Example in C#

// Returns: nothing
await client.SetHolidayTypesConfigurationAsync(InstanceInfo instance, HolidayTypesConfiguration holidayTypesConfiguration);

Example in CURL



           curl -X PUT \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/holidaytypesconfiguration \
               -H 'Authorization: Bearer TOKEN_GOES_HERE'\
               -H 'Content-Type: application/json' \
               -d '
                   {
                       "$type":"Feenics.Keep.WebApi.Model.HolidayTypesConfiguration, Feenics.Keep.WebApi.Model",
                       "TypeNames":
                       [
                           "Group 1",
                           "Group 2",
                           "Group 3",
                           "Group 4",
                           "Group 5",
                           "Group 6",
                           "Group 7",
                           "Group 8"
                       ]
                   }'