SOAP Web Service Guide For Enrico 2.0

Introduction

If you don't know what is a SOAP web service, learn more here. You can use the SOAP web service to call Enrico from any programming language. Anyway consider also using JSON interface or iCalendar interface.

WSDL

Latest version of WSDL for Enrico is here.

Details of Operations

To see details of each operation from wsdl, click here.

Examples

Enrico 2.0 SOAP UI project can be downloaded here.

Input Parameters

ParameterDescription
dayMin. value: 1, max value: 31.
monthMin. value: 1 (January), max value: 12 (December).
yearE.g. 1945, 2012, 32767
countryISO 3166-1 alpha-3 country code or ISO 3166-1 alpha-2 country code
region Possible values for New Zealand: ISO 3166-2:NZ codes - auk, bop, can, gis, hkb, mbh, mwt, nsn, ntl, ota, stl, tas, tki, wko, wgn, wtc, cit
Possible values for Australia: ISO 3166-2:AU codes - nsw, qld, sa, tas, vic, wa, act, nt
Possible values for Canada: ISO 3166-2:CA codes - ab, bc, mb, nb, nl, ns, on, pe, qc, sk, nt, nu, yt
Possible values for United States of America: ISO 3166-2:US codes - al, ak, az, ar, ca, co, ct, de, fl, ga, hi, id, il, in, ia, ks, ky, la, me, md, ma, mi, mn, ms, mo, mt, ne, nv, nh, nj, nm, ny, nc, nd, oh, ok, or, pa, ri, sc, sd, tn, tx, ut, vt, va, wa, wv, wi, wy, dc
Possible values for Germany: ISO 3166-2:DE codes - bw, by, be, bb, hb, hh, he, mv, ni, nw, rp, sl, sn, st, sh, th
Possible values for Great Britain: ISO 3166-2:GB codes - eng, nir, sct, wls
holidayType Possible values
  • all - all holiday types
  • public_holiday - public holidays
  • observance - observances, not a public holidays
  • school_holiday - school holidays
  • other_day - other important days e.g. Mother's day, Father's day etc
  • extra_working_day - extra working days. This day takes place mostly on Saturday or Sunday and is substituted for extra public holiday.

Return Value

Operations getHolidaysForMonth, getHolidaysForYear and getHolidaysForDateRange

Returns the list of holidays in form:
<holidays>
  <holiday>
    <date>
      <day>26</day>
      <month>12</month>
      <year>2022</year>
      <dayOfWeek>1</dayOfWeek>
    </date>
    <name>
      <lang>fr</lang>
      <text>Saint Etienne</text>
    </name>
    <name>
      <lang>en</lang>
      <text>Boxing Day</text>
    </name>
    <flags>REGIONAL_HOLIDAY</flags>
    <note>
      <lang>en</lang>
      <text>Observed only in Alsace and Moselle</text>
    </note>
    <holidayType>public_holiday</holidayType>
  </holiday>
</holidays>
ParameterDescription
dateDate on which holiday takes place.
Parameter dayOfWeek specifies numerical value of week day. Monday=1. Tuesday=2, ..., Saturday=6, Sunday=7.
dateToIn case holiday takes place on more than 1 day, this is the last day of holiday duration. Previous parameter date is the first day of holiday duration.
observedOnSpecifies the date on which holiday is observed. If missing holiday is observed on date specified in date parameter.
nameOne or more names for the given holiday. Every name has a ISO 639-1 language code to specify the language.
flagsOne or more flags for the given holiday. Possible flags are:
  • SHOP_CLOSING_DAY - shops are closed on this day.
  • REGIONAL_HOLIDAY - holiday does not take place in the whole country or region but only in some parts of it.
  • ADDITIONAL_HOLIDAY - holiday is an additional holiday given because main holiday takes place on Saturday or Sunday.
  • PART_DAY_HOLIDAY - holiday does not take place during the whole day.
noteOne or more notes for the given holiday. Every note has a ISO 639-1 language code to specify the language.
holidayTypeType of the holiday. Possible values are:
  • public_holiday - public holidays
  • observance - observances, not a public holidays
  • school_holiday - school holidays
  • other_day - other important days e.g. Mother's day, Father's day etc
  • extra_working_day - extra working days. This day takes place mostly on Saturday or Sunday and is substituted for extra public holiday.

Operation isPublicHoliday

Returns flag if given day is public holiday in given country.
<isPublicHoliday>
  <isHoliday>true</isHoliday>
</isPublicHoliday>

Operation isWorkDay

Returns flag if given day is work day in given country.
<isWorkDay>
  <isWorkDay>true</isWorkDay>
</isWorkDay>

Operation getSupportedCountries

Returns the list of supported countries in form:
<supportedCountries>
  <supportedCountry>
    <fullName>Australia</fullName>
    <countryCode>aus</countryCode>
    <region>act</region>
    <region>qld</region>
    <region>nsw</region>
    <region>nt</region>
    <region>sa</region>
    <region>tas</region>
    <region>vic</region>
    <region>wa</region>
    <fromDate>
      <day>1</day>
      <month>1</month>
      <year>2011</year>
    </fromDate>
    <toDate>
      <day>31</day>
      <month>12</month>
      <year>32767</year>
    </toDate>
    <holidayType>public_holiday</holidayType>
  </supportedCountry>
<supportedCountries>
ParameterDescription
fullNameDisplay name of the country.
countryCodeISO 3166-1 alpha-3 country code.
regionISO 3166-2 list of regions in the country. This list can be empty if holiday dates do not differ across country.
fromDateDate from which holidays are available for this country.
toDateDate to which holidays are available for this country.
holidayTypeList of holiday types available for this country. Possible values are:
  • public_holiday - public holidays
  • observance - observances, not a public holidays
  • school_holiday - school holidays
  • other_day - other important days e.g. Mother's day, Father's day etc
  • extra_working_day - extra working days. This day takes place mostly on Saturday or Sunday and is substituted for extra public holiday.
Enrico is powered by Kayapo