The component exposes 3 server actions:

• Get_Countries - returns the list of countries supported by Calendarific
• Get_Languages - returns the list of languages supported by Calendarific
• Get_Holidays - Returns the list of holidays in a country and year

You will need an API Key that can be obtained from https://calendarific.com/

Simply drag and drop the actions to a server or data action and set the input parameters accordingly.

Get_Countries - returns the list of countries supported by Calendarific

• Input parameters
  • API_Key - Mandatory, get one from https://calendarific.com/
• Output parameters
  • Countries - List of countries supported by Calendarific
    • CountryName - The name of the country
    • ISO3166 - Country code as per ISO 3166
    • TotalHolidays - Total number of holidays in the country
    • SupportedLanguages - Comma separated list of languages supported by the country
    • UUID - Internal country identifier
    • FlagUnicode - Unicode of the country flag
  • RequestResult - The result of the API call
    • WasSuccessful - Returns True when the API method was successfuly called
    • ErrorMessage - In case of an error calling the API, this attribute will hold the error message

Get_Languages - returns the list of languages supported by Calendarific

• Input parameters
  • API_Key - Mandatory, get one from https://calendarific.com/
• Output parameters
  • Languages - List of languages supported by Calendarific
    • Code - The language code
    • Name - The name of the language
    • NativeName - The native name of the language
  • RequestResult - The result of the API call
    • WasSuccessful - Returns True when the API method was successfuly called
    • ErrorMessage - In case of an error calling the API, this attribute will hold the error message

Get_Holidays - returns the list of holidays in a country and year

• Input parameters
  • API_Key - Mandatory, get one from https://calendarific.com/
  • Country - Mandatory, the country code (ISO 3166) to get the holidays
  • Year - Year to get holidays for the country
  • Month - Limits the number of holidays to a particular month. Must be passed as the numeric value of the month [1..12].
  • Day - Limits the number of holidays to a particular day. Must be passed as the numeric value of the day [1..31].
  • Location - We support multiple counties, states and regions for all the countries we support. This optional parameter allows you to limit the holidays to a particular state or region. The value of field is iso-3166 format of the state. View a list of supported countries and states. An example is, for New York state in the United States, it would be us-ny
  • Type - We support multiple types of holidays and observances. This parameter allows users to return only a particular type of holiday or event. By default, the API returns all holidays. Below is the list of holiday types supported by the API and this is how to reference them.'national' - Returns public, federal and bank holidays
    'local' - Returns local, regional and state holidays
    'religious' - Return religious holidays: buddhism, christian, hinduism, muslim, etc
    'observance' - Observance, Seasons, Times
  • Language - *** PREMIUM HOLIDAY API ENDPOINT PARAMETER *** Returns the name of the holiday in the official language of the country if available. This defaults to english. This must be passed as the 2-letter ISO639 Language Code.
  • UUID - *** PREMIUM HOLIDAY API ENDPOINT PARAMETER *** Returns a UUID for every holiday returned in the response [true or false].
• Output parameters
  • Holidays - List of holidays for the country and year selected
    • UUID - Internal code of the holiday (returned only for PREMIUM licenses)
    • Name - The name of the holiday
    • Description - The description of the holliday
    • CountryCode - Internal code of the country
    • CountryName - Name of the country related to the holiday
    • Date - Date of the holiday
      • ISO - ISO format of the holiday date
      • DateTime - Decomposition of the date components
        • Year
        • Month
        • Day
        • Hour
        • Minute
        • Second
      • Timezone - Timezone details of the holiday
        • Offset
        • ZoneAbb
        • ZoneOffset
        • ZoneDst
        • ZoneTotalOffset
    • Type - List of the holiday types
    • PrimaryType - Primary type of the holiday
    • CanonicalURL - Dedicated URL to the holiday details from Calendarific
    • URLId - Internal identifier of the canonical URL
    • Locations - List of country locations where the holiday applies to
    • States - List of country states where the holiday applies to
      • Id - Internal identifier of the country state
      • Abbrev - Abbreviation of the country state name
      • Name - Name of the country state
      • Exception - Details of the exception of the holiday applied to the state
      • ISO - ISO code of the country state
  • RequestResult - The result of the API call
    • WasSuccessful - Returns True when the API method was successfuly called
    • ErrorMessage - In case of an error calling the API, this attribute will hold the error message