function publicholiday.region.get

See also:

Returns detail of a particular holiday region.

Public holidays are used by some features, such as telecoms.dayparting.

Arguments:

argrequired?syntaxinfo
holiday_region stringthe name of the public holiday region

Example 1

Requesting information about holiday region "UK/England and Wales":

JSON example request:

POST https://live.apicontrol.co.uk/1/json
{
    "auth" : {
        "username" : "YOURUSERNAME",
        "password" : "YOURPASSWORD",
    },
   "func" : "publicholiday.region.get",
   "args" : {
      "holiday_region" : "UK/England and Wales"
   }
}

JSON example response:

{
   "results" : {
      "holiday_region" : "UK/England and Wales",
      "publicholidays" : [
         {
            "date" : "2021-12-27",
            "holiday_name" : "Christmas Day"
         },
         {
            "date" : "2021-12-28",
            "holiday_name" : "Boxing Day"
         },
         {
            "date" : "2022-01-03",
            "holiday_name" : "New Year's Day"
         },
         {
            "date" : "2022-04-15",
            "holiday_name" : "Good Friday"
         },
         {
            "date" : "2022-04-18",
            "holiday_name" : "Easter Monday"
         },
         {
            "date" : "2022-05-02",
            "holiday_name" : "Early May bank holiday"
         },
         {
            "date" : "2022-06-02",
            "holiday_name" : "Spring bank holiday"
         },
         {
            "date" : "2022-06-03",
            "holiday_name" : "Platinum Jubilee bank holiday"
         },
         {
            "date" : "2022-08-29",
            "holiday_name" : "Summer bank holiday"
         },
         {
            "date" : "2022-12-26",
            "holiday_name" : "Boxing Day"
         },
         {
            "date" : "2022-12-27",
            "holiday_name" : "Christmas Day"
         }
      ]
   },
   "success" : 1
}