Tagesinformation, ob an diesem Datum ein Feiertag gilt, und/oder Schulferien sind
Kapitel:
Ermöglicht Abfragen mittels mittels Datum und Schweizer Postleitzahlen. Gibt aus, ob und zu wieviel Prozent an diesem Tag ein Feiertag gilt, oder Schulferien sind.
Die Abfrage funktioniert auch für Postleitzahlen in Liechtenstein.
Zum Abrufen der Daten verwenden Sie folgende URL. Achten Sie bitte auf Gross-Kleinschrift.
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 |
PLZ erforderlich |
Schweizer Postleitzahl | &PLZ=2504 |
date | Datum der gewünschten Daten |
&date=2024-05-20 |
class oder klasse |
Umfang der Daten Varianten: |
&klasse=5 |
charset | Die gewünschte Codierung der Antwort Varianten: |
&charset=iso-8859-1 |
format | Das gewünschte Ausgabeformat Varianten: |
&format=xml |
date_format | Das gewünschte Datumformat Varianten: |
&date_format=d.m.Y |
hl | Gewünschte Sprache der Ausgabe Varianten: |
&hl=en |
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 | CheckDate/CH/PLZ | ||||
apiStatus | description | Bezeichnung des API-Status. Für Varianten, siehe unter Fehlermeldungen | active | |||
date | Datum des Datenexports | 20.04.2024 | ||||
request: | plz | Schweizer Postleitzahl | 2504 | |||
date | Datum der Daten in der Ausgabe | 2019-04-15 | ||||
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 | Biel | |||
type | Bezeichnung der Art der geografischen Einheit | Stadt | ||||
geoId | Geo-ID der geografischen Einheit. | 424 | ||||
iso | ISO-Landeskürzel, 2-stellig | CH | ||||
iso-3166-2 | Regionencode nach ISO 3166-2 | CH-BE | ||||
note | Besondere Hinweise | NEU 30.03.2023 | ||||
date_status | Tagesstatus | |||||
date | Datum | 2019-04-15 | ||||
total_population | Gesamtzahl der Einwohner | 54640 | ||||
public_holiday_population | Anzahl Einwohner mit Feiertag | 0 | ||||
public_holiday_percent | Prozent Einwohner mit Feiertag | 0 | ||||
public_holiday_description | Bezeichnung des Feiertags | |||||
school_holiday_population | Anzahl Einwohner mit Schulferien | 54640 | ||||
school_holiday_percent | Prozent Einwohner mit Schulferien | 100 | ||||
school_holiday_description | Bezeichnung Schulferien | Frühlingsferien | ||||
sum_population | Summe der betroffenen Einwohner | 54640 | ||||
percent_population | Prozent der betroffenen Einwohner | 100 |
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. |
Die angeforderte Schweizer Postleitzahl ist nicht bekannt. Prüfen Sie bitte den Parameter PLZ. |
results: status: description | unknown location | Die angeforderte Schweizer Postleitzahl ist nicht bekannt. Prüfen Sie bitte den Parameter PLZ. |
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. |
URL:
https://feiertagskalender.ch/api/CheckDate/CH/PLZ/?api_key=YOUR_API_KEY&plz=2504&date=2019-04-15
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":"CheckDate/CH/PLZ", "apiStatus":{ "description":"active" }, "date":"2024-04-20", "request":{ "plz":"2504", "date":"2019-04-15", "charset":"utf-8", "format":"json", "date_format":"Y-m-d", "hl":"de" }, "results":{ "status":{ "description":"ok" }, "location":{ "description":"Biel/Bienne", "type":"Gemeinde", "geoId":"424", "iso":"CH", "iso-3166-2":"CH-BE", "date_status":{ "date":"2019-04-15", "total_population":54640, "public_holiday_population":0, "public_holiday_percent":0, "public_holiday_description":null, "school_holiday_population":54640, "school_holiday_percent":100, "school_holiday_description":"Frühlingsferien", "sum_population":54640, "sum_percent":100 } } } }
URL:
https://feiertagskalender.ch/api/CheckDate/CH/PLZ/?api_key=YOUR_API_KEY&plz=2504&date=2019-04-15&format=XML
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>CheckDate/CH/PLZ</apiName> <date>2019-04-11</date> <request> <plz>2504</plz> <date>2019-04-15</date> <charset>utf-8</charset> <format>xml</format> <date_format>Y-m-d</date_format> <hl>de</hl> </request> <results> <status> <description>ok</description> </status> <location> <description>Biel/Bienne</description> <type>Gemeinde</type> <geoId>424</geoId> <iso>CH</iso> <iso-3166-2>CH-BE</iso-3166-2> <date_status> <date>2019-04-15</date> <total_population>54640</total_population> <public_holiday_population>0</public_holiday_population> <public_holiday_percent>0</public_holiday_percent> <public_holiday_description/> <school_holiday_population>54640</school_holiday_population> <school_holiday_percent>100</school_holiday_percent> <school_holiday_description>Frühlingsferien</school_holiday_description> <sum_population>54640</sum_population> <sum_percent>100</sum_percent> </date_status> </location> </results> </fcal_api>
URL:
https://feiertagskalender.ch/api/CheckDate/CH/PLZ/?api_key=YOUR_API_KEY&plz=2504&date=2019-04-15&format=csv
Antwort des APIs:
"location";"plz";"iso";"iso-3166-2";"date";"total_population";"public_holiday_population";"public_holiday_percent";"public_holiday_description";"school_holiday_population";"school_holiday_percent";"school_holiday_description";"sum_population";"sum_percent" "Biel/Bienne";"2504";"CH";"CH-BE";"2019-04-15";"54640";"0";"0";"";"54640";"100";"Frühlingsferien";"54640";"100"