API-Dokumentation

Jahresdaten

Jahresdaten für 1 Ort auslesen

Datensets mit den Feiertagen und Schulferien eines Jahres.

API: Data/LatLon

Kapitel:

API: Data/LatLon

Funktion

Ermöglicht Abfragen per Geokoordinaten. Gibt Feiertage und Schulferien der entsprechenden Gemeinde/Region aus. Zur Verbesserung der Treffer in Randgebieten kann zusätzlich ein ISO-Länderkürzel mitgeschickt werden, und/oder die Suchdistanz verändert werden.

Achtung: Die Lokalisierung erfolgt mittels Distanzmessung. In Randgebieten kann die Zuweisung deshalb falsche Resultate liefern.

URL für Anfragen

Zum Abrufen der Daten verwenden Sie folgende URL. Achten Sie bitte auf Gross-Kleinschrift.

Parameter für Anfragen

Mit den folgenden Variablen können Sie die Abfrage vervollständigen und die API-Ergebnisse steuern.

Parameter Erläuterung Beispiele
api_key
erforderlich

Ihr API-Key

?api_key=abc-123-def-456
lat
erforderlich
Latitude. Geografische Breite &lat=46.9576
lon
erforderlich
Longitude. Geografische Länge &lon=7.45134
iso ISO-Landeskürzel, 2-stellig

Optionale Zusatzinformation für verbesserte Zuweisung.
&iso=CH
dist Maximale Suchdistanz in km

ohne Angabe: 100km (= Standard)
&dist=200
year
oder
jahr

Jahr der gewünschten Daten

ohne Angabe: laufendes Kalenderjahr (= Standard)

&year= 2025
class
oder
klasse

Umfang der Daten

Varianten:
0 = nur Schulferien
3 = 0 + gesetzlich anerkannte Feiertage
4 = 0 + 3 + gesetzliche und gesetzlich nicht anerkannte Feiertage (religiöse, kulturelle) (= Standard)
5 = 0 + 3 + 4 + Ereignistage (z.B. Valentinstag, Muttertag, Advent)

&klasse=5
charset

Die gewünschte Codierung der Antwort

Varianten:
UTF-8 (= Standard)
ISO-8859-1

&charset=iso-8859-1
format

Das gewünschte Ausgabeformat

Varianten:
JSON (= Standard)
XML
CSV

&format=xml
date_format

Das gewünschte Datumformat
Das Format entspricht der Datumsformatierung der PHP-Anweisung date()

Varianten:
Y-m-d = YYYY-MM-DD (ISO-8601) (= Standard)
d.m.Y = DD.MM.YYYY
Ymd = YYYYMMDD
dmY = DDMMYYYY
d.m.y = DD.MM.YY
j.n.y = D.M.YY

&date_format=d.m.Y
hl

Gewünschte Sprache der Ausgabe

Varianten:
de = Deutsch (= Standard)
fr = Französisch
it = Italienisch
en = Englisch

&hl=en

Rückgabewerte des API

Die Inhalte der API-Antworten ergeben sich aus:
- den von Ihnen abonnierten Daten (Länder, Feiertage, Schulferien, Kalenderjahre)
- den offiziell bekannten Daten der Gesetzgeber
- der Verfügbarkeit aufgrund unserer Recherchen (IST-Situation unserer Datenbank)

Beachten Sie bitte, dass die Ausgabe im CSV-Format abweicht.

Array         Erläuterung Beispiel
interface         Version des API  
source: href       URL zur Datenquelle (Website)  
  description       Bezeichnung der Datenquelle  
copyright href       URL zum Inhaber des Copyrights (Website)  
  description       Bezeichnung des Copyright-Inhabers  
apiName         Identifikation des API Data/LatLon
apiStatus description       Bezeichnung des API-Status. Für Varianten, siehe unter Fehlermeldungen active
date         Datum des Datenexports 29.03.2024
request: lat       Latitude. Geografische Breite 46.9576
  lon       Longitude. Geografische Länge 7.45134
  iso       ISO-Landeskürzel, 2-stellig CH
  dist       Maximale Suchdistanz in km 100
  year       Jahr der Daten in der Ausgabe 2015
  class       Klasse der Abfrage (betrifft den Umfang der Daten) 4
  charset       Schriftcodierung der Ausgabe utf-8
  format       Datenformat der Ausgabe json
  date_format       Datumformat der Ausgabe d.m.Y
  hl       Sprache der Ausgabe, gemäss Anfrage de
results status description     Status der Ausgabe. Für Varianten, siehe unter Fehlermeldungen ok
  location description     Bezeichnung der geografischen Einheit Bern
    type     Bezeichnung der Art der geografischen Einheit Stadt
    geoId     Geo-ID der geografischen Einheit. 410
    iso     ISO-Landeskürzel, 2-stellig BE
    iso-3166-2     Regionencode nach ISO 3166-2  
    note     Besondere Hinweise NEU 30.03.2023
    events     Die Kalenderevents  
      description   Bezeichnung des Feiertags, oder der Schulferien Neujahr
      id   Eindeutige ID des Events.
Feiertage haben jedes Jahr dieselbe ID.
Schulferien haben alle ihre eigenen IDs.
1
      dateStart   Datum Beginn des Events 01.01.2015
      dateEnd   Datum Ende des Events 01.01.2015
      class   Klasse des Events:

0 = Schulferien
1 = gesetzlich anerkannter Feiertag
2 = den Sonntagen gleichgestellter Feiertag
3 = halber, gesetzlich anerkannter Feiertag (meist ab Mittag)
4 = gesetzlich nicht anerkannter Feiertag (Geschäfte, Schulen, Verwaltungen meist geschlossen), Bankenfeiertag; im Sinne des Europäischen Übereinkommens über die Berechnung der Fristen wird dieser Tag wie ein gesetzlicher Feiertag behandelt (Art. 5).
5 = Ereignistag
# = nur teilweise gültig
2
      percent   Umfang der betroffenen Einwohner / Schulklassen in Prozent 100
      prov   Flag für provisorisch festgelegte Daten

0 = definitiv
1 = provisorisch
0
      note   besondere hinweise  

Fehlermeldungen

Art der Ausgabe Fehlermeldung Erläuterung
results: status:
results: status: description not subscribed Sie haben die gewünschten Daten nicht abonniert.
Wenden Sie sich bitte an unseren Support.
results: status: description unknown location Die angeforderten Koordinaten konnten nicht zugeordnet werden.
Die Koordinaten liegen ausserhalb des erfassten Gebiets, oder sind ungültig.
Prüfen Sie bitte die Parameter lat und lon
apiStatus
apiStatus: description invalid usage Die Verwendung dieses API ist für Sie nicht freigeschaltet.
Wenden Sie sich bitte an unseren Support.
apiStatus: description invalid key Ungültiger API-Key.
Prüfen Sie bitte Ihren API-Key.
apiStatus: description invalid referer Ungültiger Zugriff. Links ab Webseiten (Front-Ends) sind nicht zulässig.
Richten Sie Ihre Abfrage so ein, dass diese aus einem geschützten Back-End erfolgt.
Wenden Sie sich allenfalls an unseren Support.
apiStatus: description inactive Das API wurde für Sie noch nicht zur Benutzung freigeschaltet.
Versuchen Sie es bitte zu einem späteren Zeitpunkt noch einmal.
apiStatus: description expired Die Nutzungsdauer nach Vertrag ist abgelaufen.
Wenden Sie sich für eine Vertragsverlängerung an unsere Administration.

Beispiele

JSON

URL:
https://feiertagskalender.ch/api/Data/LatLon/?api_key=YOUR_API_KEY&jahr=2015&date_format=d.m.Y&lat=46.9576&lon=7.45134

Antwort des APIs:

{
	"interface": "fcal API 2.0",
	"source": {
		"href": "https://feiertagskalender.ch",
		"description": "feiertagskalender.ch"
	},
	"copyright": {
		"href": "https://psc.ch",
		"description": "psc Peter Schuetz Informatik-Dienstleistungen, CH Bern"
	},
	"apiName": "Data/CH/LatLon",
	"apiStatus": {
		"description": "active"
	},
	"date": "04.08.2017",
	"request": {
		"lat": "46.9576",
		"lon": "7.45134",
		"iso": "",
		"dist": "100",
		"year": "2015",
		"class": "4",
		"charset": "utf-8",
		"format": "json",
		"hl": "de"
	},
	"results": {
		"status": {
			"description": "ok"
		}, {
		"location": {
			"description": "Bern",
			"type": "Stadt",
			"geoId": "410",
			"iso": "CH",
			"iso-3166-2": "CH-BE",
			"events": [{
				"description": "Neujahrstag",
				"id": "1",
				"dateStart": "01.01.2015",
				"dateEnd": "01.01.2015",
				"class": "2",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Berchtoldstag",
				"id": "3",
				"dateStart": "02.01.2015",
				"dateEnd": "02.01.2015",
				"class": "2",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Karfreitag",
				"id": "17",
				"dateStart": "03.04.2015",
				"dateEnd": "03.04.2015",
				"class": "2",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Ostern",
				"id": "18",
				"dateStart": "05.04.2015",
				"dateEnd": "05.04.2015",
				"class": "4",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Ostermontag",
				"id": "19",
				"dateStart": "06.04.2015",
				"dateEnd": "06.04.2015",
				"class": "2",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Auffahrt",
				"id": "31",
				"dateStart": "14.05.2015",
				"dateEnd": "14.05.2015",
				"class": "2",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Pfingsten",
				"id": "30",
				"dateStart": "24.05.2015",
				"dateEnd": "24.05.2015",
				"class": "4",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Pfingstmontag",
				"id": "35",
				"dateStart": "25.05.2015",
				"dateEnd": "25.05.2015",
				"class": "2",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Nationalfeiertag Schweiz",
				"id": "12",
				"dateStart": "01.08.2015",
				"dateEnd": "01.08.2015",
				"class": "2",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Weihnachten",
				"id": "23",
				"dateStart": "25.12.2015",
				"dateEnd": "25.12.2015",
				"class": "2",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Stephanstag",
				"id": "37",
				"dateStart": "26.12.2015",
				"dateEnd": "26.12.2015",
				"class": "2",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Winterferien",
				"id": "212582",
				"dateStart": "20.12.2014",
				"dateEnd": "4.01.2015",
				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Sportferien",
				"id": "220573",
				"dateStart": "31.01.2015",
				"dateEnd": "8.02.2015",
				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Fr\u00fchlingsferien",
				"id": "212583",
				"dateStart": "3.04.2015",
				"dateEnd": "19.04.2015",
				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Auffahrtsferien",
				"id": "220574",
				"dateStart": "14.05.2015",
				"dateEnd": "17.05.2015",

				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Sommerferien",
				"id": "212584",
				"dateStart": "4.07.2015",
				"dateEnd": "9.08.2015",
				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Herbstferien",
				"id": "212585",
				"dateStart": "19.09.2015",
				"dateEnd": "11.10.2015",

				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Winterferien",
				"id": "421836",
				"dateStart": "25.12.2015",
				"dateEnd": "10.01.2016",
				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}]
		}
	}
}					

XML

URL:
https://feiertagskalender.ch/api/Data/LatLon/?api_key=YOUR_API_KEY&jahr=2015&date_format=d.m.Y&format=xml&charset=ISO-8859-1&lat=46.9576&lon=7.45134

Antwort des APIs:

<fcal_api>
	<interface>fcal API 2.0</interface>
	<source>
		<href>https://feiertagskalender.ch</href>
		<description>feiertagskalender.ch</description>
	</source>
	<copyright>
		<href>https://psc.ch</href>
		<description>psc Peter Schuetz Informatik-Dienstleistungen, CH Bern</description>
	</copyright>
	<apiStatus>
		<description>active</description>
	</apiStatus>
	<apiName>Data/CH/LatLon</apiName>	
	<date>04.08.2017</date>
	<request>
		<lat>46.9576</lat>
		<lon>7.45134</lon>
		<iso></iso>
		<dist>100</dist>
		<year>2015</year>
		<class>4</class>
		<charset>utf-8</charset>
		<format>xml</format>
		<hl>de</hl>
	</request>
	<results>
		<status>
			<description>ok</description>
		</status>	
		<location>
			<description>Bern</description>
			<type>Stadt</type>
			<geoId>410</geoId>
			<iso>CH</iso>
			<iso-3166-2>CH-BE</iso-3166-2>
			<events>
				<event>
					<description>Neujahrstag</description>
					<id>1</id>
					<dateStart>01.01.2015</dateStart>
					<dateEnd>01.01.2015</dateEnd>
					<class>2</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Berchtoldstag</description>
					<id>3</id>
					<dateStart>02.01.2015</dateStart>
					<dateEnd>02.01.2015</dateEnd>
					<class>2</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Karfreitag</description>
					<id>17</id>
					<dateStart>03.04.2015</dateStart>
					<dateEnd>03.04.2015</dateEnd>
					<class>2</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Ostern</description>
					<id>18</id>
					<dateStart>05.04.2015</dateStart>
					<dateEnd>05.04.2015</dateEnd>
					<class>4</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Ostermontag</description>
					<id>19</id>
					<dateStart>06.04.2015</dateStart>
					<dateEnd>06.04.2015</dateEnd>
					<class>2</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Auffahrt</description>
					<id>31</id>
					<dateStart>14.05.2015</dateStart>
					<dateEnd>14.05.2015</dateEnd>
					<class>2</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Pfingsten</description>
					<id>30</id>
					<dateStart>24.05.2015</dateStart>
					<dateEnd>24.05.2015</dateEnd>
					<class>4</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Pfingstmontag</description>
					<id>35</id>
					<dateStart>25.05.2015</dateStart>
					<dateEnd>25.05.2015</dateEnd>
					<class>2</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Nationalfeiertag Schweiz</description>
					<id>12</id>
					<dateStart>01.08.2015</dateStart>
					<dateEnd>01.08.2015</dateEnd>
					<class>2</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Weihnachten</description>
					<id>23</id>
					<dateStart>25.12.2015</dateStart>
					<dateEnd>25.12.2015</dateEnd>
					<class>2</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Stephanstag</description>
					<id>37</id>
					<dateStart>26.12.2015</dateStart>
					<dateEnd>26.12.2015</dateEnd>
					<class>2</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Winterferien</description>
					<id>212582</id>
					<dateStart>20.12.2014</dateStart>
					<dateEnd>4.01.2015</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Sportferien</description>
					<id>220573</id>
					<dateStart>31.01.2015</dateStart>
					<dateEnd>8.02.2015</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Frühlingsferien</description>
					<id>212583</id>
					<dateStart>3.04.2015</dateStart>
					<dateEnd>19.04.2015</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Auffahrtsferien</description>
					<id>220574</id>
					<dateStart>14.05.2015</dateStart>
					<dateEnd>17.05.2015</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Sommerferien</description>
					<id>212584</id>
					<dateStart>4.07.2015</dateStart>
					<dateEnd>9.08.2015</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Herbstferien</description>
					<id>212585</id>
					<dateStart>19.09.2015</dateStart>
					<dateEnd>11.10.2015</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Winterferien</description>
					<id>421836</id>
					<dateStart>25.12.2015</dateStart>
					<dateEnd>10.01.2016</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
			</events>
		</location>
	</results>
</fcal_api>                  

CSV

URL:
https://feiertagskalender.ch/api/Data/LatLon/?api_key=YOUR_API_KEY&charset=iso-8859-1&date_format=d.m.Y
&lat=46.9576&lon=7.45134&jahr=2015&format=csv

Antwort des APIs:

"location";"geoId";"description";"id";"dateStart";"dateEnd";"class";"percent";"prov";"note"
"Bern";"410";"Neujahrstag";"1";"01.01.2015";"01.01.2015";"2";"100";"0";""
"Bern";"410";"Berchtoldstag";"3";"02.01.2015";"02.01.2015";"2";"100";"0";""
"Bern";"410";"Karfreitag";"17";"03.04.2015";"03.04.2015";"2";"100";"0";""
"Bern";"410";"Ostern";"18";"05.04.2015";"05.04.2015";"4";"100";"0";""
"Bern";"410";"Ostermontag";"19";"06.04.2015";"06.04.2015";"2";"100";"0";""
"Bern";"410";"Auffahrt";"31";"14.05.2015";"14.05.2015";"2";"100";"0";""
"Bern";"410";"Pfingsten";"30";"24.05.2015";"24.05.2015";"4";"100";"0";""
"Bern";"410";"Pfingstmontag";"35";"25.05.2015";"25.05.2015";"2";"100";"0";""
"Bern";"410";"Nationalfeiertag Schweiz";"12";"01.08.2015";"01.08.2015";"2";"100";"0";""
"Bern";"410";"Weihnachten";"23";"25.12.2015";"25.12.2015";"2";"100";"0";""
"Bern";"410";"Stephanstag";"37";"26.12.2015";"26.12.2015";"2";"100";"0";""
"Bern";"410";"Winterferien";"212582";"20.12.2014";"4.01.2015";"0";"100";"0";""
"Bern";"410";"Sportferien";"220573";"31.01.2015";"8.02.2015";"0";"100";"0";""
"Bern";"410";"Frühlingsferien";"212583";"3.04.2015";"19.04.2015";"0";"100";"0";""
"Bern";"410";"Auffahrtsferien";"220574";"14.05.2015";"17.05.2015";"0";"100";"0";""
"Bern";"410";"Sommerferien";"212584";"4.07.2015";"9.08.2015";"0";"100";"0";""
"Bern";"410";"Herbstferien";"212585";"19.09.2015";"11.10.2015";"0";"100";"0";""
"Bern";"410";"Winterferien";"421836";"25.12.2015";"10.01.2016";"0";"100";"0";""
               			
Seiten
Partnerprojekte
©2003 - 2024 psc Peter Schütz Informatik Dienstleistungen, CH-Bern