API-Dokumentation

Geographische Daten

API: GeoTree/ISO

Holt den geopraphischen Baum für alle verfügbaren Einträge eines Landes, basierend auf einem ISO-Länderkürzel (iso).

Funktion

Diese API liest den geographischen Baum eines Landes oder einer Region aus. Damit können die für weitere Abfragen benötigten geoIds ermittelt werden. Erforderliche Parameter sind `api_key` und `iso`. Zusätzlich kann die Ausgabe über weitere Parameter konfiguriert werden. Die Parameter werden als Query-Parameter in der URL übergeben. Alternativ kann die Autorisierung auch im Header erfolgen.

**Hinweis:** Der geographische Baum enthält alle Einträge, die sich aus der Notwendigkeit ergeben, Feiertage und Schulferien korrekt darzustellen. Zusätzlich existiert eine separate Ortsdatenbank mit zusätzlichen Orten, die innerhalb unserer Baumstruktur verortet sind. Mit dem Parameter `cities` (0/1) kann festgelegt werden, ob die Ortsdatenbank in die Ausgabe des geographischen Baums einbezogen werden soll.


Interaktive Anleitung und OpenAPI

OpenAPI 3.0 (Swagger) – Interaktive API-Dokumentation

Öffnet die interaktive API-Dokumentation mit Swagger, in der Sie API-Endpunkte testen und erkunden können.

OpenAPI JSON-Spezifikation herunterladen

URL für Anfragen

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

POST / GET
https://feiertagskalender.ch/api/GeoTree/ISO/index.php

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-Schlüssel api_key=abc-123-def-456
iso
erforderlich
ISO-Landeskürzel, 2-stellig, oder
Regionencode nach ISO 3166-2
iso=DE-BW
cities

Flag für erweiterten Export mit erfassten Städten:

Varianten:
0 = Ohne Cities (= Standard)
1 = Inklusive Cities

&cities=1
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
hl

Gewünschte Sprache der Ausgabe

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

hl=en

Beispiele (URL / PHP / Python / JavaScript)

Beispiele anzeigen

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 GeoTree/ISO
apiStatus description       Bezeichnung des API-Status. Für Varianten, siehe unter Fehlermeldungen active
date         Datum des Datenexports 01.05.2025
request: iso       ISO-Landeskürzel, 2-stellig BE
  charset       Schriftcodierung der Ausgabe utf-8
  format       Datenformat der Ausgabe json
  hl       Sprache der Ausgabe, gemäss Anfrage de
results status description     Status der Ausgabe. Für Varianten, siehe unter Fehlermeldungen ok
  location       Geografische Einheit gemäss Anfrage  
    description     Bezeichnung der geografischen Einheit Belgien
    type     Bezeichnung der Art der geografischen Einheit Land
    geoId     Geo-ID der geografischen Einheit. 3285
    iso     ISO-Landeskürzel, 2-stellig BE
    iso-3166-2     Regionencode nach ISO 3166-2  
    cities     Allfällige erfasste Städte und Ortschafen in dieser Region  
      description      
      cityId      
    children     Allfällige untergeordnete geografische Einheiten  
      description   Bezeichnung der geografischen Einheit Brüssel
      type   Bezeichnung der Art der geografischen Einheit Region
      geoId   Geo-ID der geografischen Einheit. 3288
      iso   ISO-Landeskürzel, 2-stellig BE
      iso-3166-2   Regionencode nach ISO 3166-2 BE-BRU
      cities   Allfällige erfasste Städte und Ortschafen in dieser Region  
      children   Allfällige untergeordnete geografische Einheiten
(bis 4 Ebenen sind möglich)
array

Beispiele (JSON / XML / CSV)

JSON

URL:
https://www.feiertagskalender.ch/api/GeoTree/ISO/index.php?api_key=YOUR_API_KEY&iso=FR

Antwort des APIs:

{
    "interface": "fcal API 2.02",
    "source": {
        "href": "https://feiertagskalender.ch",
        "description": "feiertagskalender.ch"
    },
    "copyright": {
        "href": "https://psc.ch",
        "description": "psc Peter Schuetz Informatik-Dienstleistungen, CH Arch"
    },
    "apiName": "GeoTree/ISO",
    "apiStatus": {
        "description": "active"
    },
    "date": "2025-02-28",
    "request": {
        "iso": "FR",
        "charset": "utf-8",
        "format": "json",
        "hl": "de"
    },
    "results": {
        "status": {
            "description": "ok"
        },
        "location": {
            "description": "Frankreich",
            "type": "Land",
            "geoId": "3079",
            "iso": "FR",
            "iso-3166-2": "",
            "cities": null,
            "children": [
                {
                    "description": "Auvergne-Rhône-Alpes",
                    "type": "Region",
                    "geoId": "3099",
                    "iso": "FR",
                    "iso-3166-2": "FR-ARA",
                    "cities": null,
                    "children": [
                        {
                            "description": "Ain",
                            "type": "Departement",
                            "geoId": "4142",
                            "iso": "FR",
                            "iso-3166-2": "FR-01",
                            "cities": null,
                            "children": null
                        },
                        {
                            "description": "Allier",
                            "type": "Departement",
                            "geoId": "4143",
                            "iso": "FR",
                            "iso-3166-2": "FR-03",
                            "cities": null,
                            "children": null
                        },
                        {
                            "description": "Ardèche",
                            "type": "Departement",
                            "geoId": "4144",
                            "iso": "FR",
                            "iso-3166-2": "FR-07",
                            "cities": null,
                            "children": null
                        },
                        {
                            "description": "Cantal",
                            "type": "Departement",
                            "geoId": "4145",
                            "iso": "FR",
                            "iso-3166-2": "FR-15",
                            "cities": null,
                            "children": null
                        },
                        {
                            "description": "Drôme",
                            "type": "Departement",
                            "geoId": "4146",
                            "iso": "FR",
                            "iso-3166-2": "FR-26",
                            "cities": null,
                            "children": null
                        },
                        {
                            "description": "Haute-Loire",
                            "type": "Departement",
                            "geoId": "4149",
                            "iso": "FR",
                            "iso-3166-2": "FR-43",
                            "cities": null,
                            "children": null
                        },
                        {
                            "description": "Haute-Savoie",
                            "type": "Departement",
                            "geoId": "4154",
                            "iso": "FR",
                            "iso-3166-2": "FR-74",
                            "cities": null,
                            "children": null
                        },
                        {
                            "description": "Isère",
                            "type": "Departement",
                            "geoId": "4147",
                            "iso": "FR",
                            "iso-3166-2": "FR-38",
                            "cities": null,
                            "children": null
                        },
                        {
                            "description": "Loire",
                            "type": "Departement",
                            "geoId": "4148",
                            "iso": "FR",
                            "iso-3166-2": "FR-42",
                            "cities": null,
                            "children": null
                        },
                        {
                            "description": "Métropole de Lyon",
                            "type": "Departement",
                            "geoId": "4152",
                            "iso": "FR",
                            "iso-3166-2": "FR-69",
                            "cities": null,
                            "children": null
                        },
                        {
                            "description": "Puy-de-Dôme",
                            "type": "Departement",
                            "geoId": "4150",
                            "iso": "FR",
                            "iso-3166-2": "FR-63",
                            "cities": null,
                            "children": null
                        },
                        {
                            "description": "Rhône",
                            "type": "Departement",
                            "geoId": "4151",
                            "iso": "FR",
                            "iso-3166-2": "FR-69",
                            "cities": null,
                            "children": null
                        },
                        {
                            "description": "Savoie",
                            "type": "Departement",
                            "geoId": "4153",
                            "iso": "FR",
                            "iso-3166-2": "FR-73",
                            "cities": null,
                            "children": null
                        }
                    ]
                },
                {
                    "description": "Bourgogne-Franche-Comté",
                    "type": "Region",
                    "geoId": "3101",
                    "iso": "FR",
                    "iso-3166-2": "FR-BFC",
                    "cities": null,
                    "children": [
                        {
                            "description": "Côte-d’Or",
                            "type": "Departement",
                            "geoId": "4207",
                            "iso": "FR",
                            "iso-3166-2": "FR-21",
                            "cities": null,
                            "children": null
                        },
                        {
                            "description": "Doubs",
                            "type": "Departement",
                            "geoId": "4208",
                            "iso": "FR",
                            "iso-3166-2": "FR-25",
                            "cities": null,
                            "children": null
                        },
                        {
                            "description": "Haute-Saône",
                            "type": "Departement",
                            "geoId": "4211",
                            "iso": "FR",
                            "iso-3166-2": "FR-70",
                            "cities": null,
                            "children": null
                        },
                        {
                            "description": "Jura",
                            "type": "Departement",
                            "geoId": "4209",
                            "iso": "FR",
                            "iso-3166-2": "FR-39",
                            "cities": null,
                            "children": null
                        },
                        {
                            "description": "Nièvre",
                            "type": "Departement",
                            "geoId": "4210",
                            "iso": "FR",
                            "iso-3166-2": "FR-58",
                            "cities": null,
                            "children": null
                        },
                        {
                            "description": "Saône-et-Loire",
                            "type": "Departement",
                            "geoId": "4212",
                            "iso": "FR",
                            "iso-3166-2": "FR-71",
                            "cities": null,
                            "children": null
                        },
                        {
                            "description": "Territoire de Belfort",
                            "type": "Departement",
                            "geoId": "4214",
                            "iso": "FR",
                            "iso-3166-2": "FR-90",
                            "cities": null,
                            "children": null
                        },
                        {
                            "description": "Yonne",
                            "type": "Departement",
                            "geoId": "4213",
                            "iso": "FR",
                            "iso-3166-2": "FR-89",
                            "cities": null,
                            "children": null
                        }
                    ]
                }
            ]
        }
    }
}

XML

URL:
https://www.feiertagskalender.ch/api/GeoTree/ISO/index.php?api_key=YOUR_API_KEY&iso=FR&format=xml

Antwort des APIs:

<fcal_api>
<interface>fcal API 2.02</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>GeoTree/ISO</apiName>
<date>2025-02-28</date>
<request>
<iso>FR</iso>
<charset>utf-8</charset>
<format>xml</format>
<hl>de</hl>
</request>
<results>
<status>
<description>ok</description>
</status>
<location>
<description>Frankreich</description>
<type>Land</type>
<geoId>3079</geoId>
<iso>FR</iso>
<iso-3166-2></iso-3166-2>
<cities></cities>
<children>
<child>
<description>Auvergne-Rhône-Alpes</description>
<type>Region</type>
<geoId>3099</geoId>
<iso>FR</iso>
<iso-3166-2>FR-ARA</iso-3166-2>
<cities></cities>
<children>
<child>
<description>Ain</description>
<type>Departement</type>
<geoId>4142</geoId>
<iso>FR</iso>
<iso-3166-2>FR-01</iso-3166-2>
<cities></cities>
<children></children>
</child>
<child>
<description>Allier</description>
<type>Departement</type>
<geoId>4143</geoId>
<iso>FR</iso>
<iso-3166-2>FR-03</iso-3166-2>
<cities></cities>
<children></children>
</child>
<child>
<description>Ardèche</description>
<type>Departement</type>
<geoId>4144</geoId>
<iso>FR</iso>
<iso-3166-2>FR-07</iso-3166-2>
<cities></cities>
<children></children>
</child>
<child>
<description>Cantal</description>
<type>Departement</type>
<geoId>4145</geoId>
<iso>FR</iso>
<iso-3166-2>FR-15</iso-3166-2>
<cities></cities>
<children></children>
</child>
<child>
<description>Drôme</description>
<type>Departement</type>
<geoId>4146</geoId>
<iso>FR</iso>
<iso-3166-2>FR-26</iso-3166-2>
<cities></cities>
<children></children>
</child>
<child>
<description>Haute-Loire</description>
<type>Departement</type>
<geoId>4149</geoId>
<iso>FR</iso>
<iso-3166-2>FR-43</iso-3166-2>
<cities></cities>
<children></children>
</child>
<child>
<description>Haute-Savoie</description>
<type>Departement</type>
<geoId>4154</geoId>
<iso>FR</iso>
<iso-3166-2>FR-74</iso-3166-2>
<cities></cities>
<children></children>
</child>
<child>
<description>Isère</description>
<type>Departement</type>
<geoId>4147</geoId>
<iso>FR</iso>
<iso-3166-2>FR-38</iso-3166-2>
<cities></cities>
<children></children>
</child>
<child>
<description>Loire</description>
<type>Departement</type>
<geoId>4148</geoId>
<iso>FR</iso>
<iso-3166-2>FR-42</iso-3166-2>
<cities></cities>
<children></children>
</child>
<child>
<description>Métropole de Lyon</description>
<type>Departement</type>
<geoId>4152</geoId>
<iso>FR</iso>
<iso-3166-2>FR-69</iso-3166-2>
<cities></cities>
<children></children>
</child>
<child>
<description>Puy-de-Dôme</description>
<type>Departement</type>
<geoId>4150</geoId>
<iso>FR</iso>
<iso-3166-2>FR-63</iso-3166-2>
<cities></cities>
<children></children>
</child>
<child>
<description>Rhône</description>
<type>Departement</type>
<geoId>4151</geoId>
<iso>FR</iso>
<iso-3166-2>FR-69</iso-3166-2>
<cities></cities>
<children></children>
</child>
<child>
<description>Savoie</description>
<type>Departement</type>
<geoId>4153</geoId>
<iso>FR</iso>
<iso-3166-2>FR-73</iso-3166-2>
<cities></cities>
<children></children>
</child>

</children>
</child>
<child>
<description>Bourgogne-Franche-Comté</description>
<type>Region</type>
<geoId>3101</geoId>
<iso>FR</iso>
<iso-3166-2>FR-BFC</iso-3166-2>
<cities></cities>
<children>
<child>
<description>Côte-d’Or</description>
<type>Departement</type>
<geoId>4207</geoId>
<iso>FR</iso>
<iso-3166-2>FR-21</iso-3166-2>
<cities></cities>
<children></children>
</child>
<child>
<description>Doubs</description>
<type>Departement</type>
<geoId>4208</geoId>
<iso>FR</iso>
<iso-3166-2>FR-25</iso-3166-2>
<cities></cities>
<children></children>
</child>
<child>
<description>Haute-Saône</description>
<type>Departement</type>
<geoId>4211</geoId>
<iso>FR</iso>
<iso-3166-2>FR-70</iso-3166-2>
<cities></cities>
<children></children>
</child>
<child>
<description>Jura</description>
<type>Departement</type>
<geoId>4209</geoId>
<iso>FR</iso>
<iso-3166-2>FR-39</iso-3166-2>
<cities></cities>
<children></children>
</child>
<child>
<description>Nièvre</description>
<type>Departement</type>
<geoId>4210</geoId>
<iso>FR</iso>
<iso-3166-2>FR-58</iso-3166-2>
<cities></cities>
<children></children>
</child>
<child>
<description>Saône-et-Loire</description>
<type>Departement</type>
<geoId>4212</geoId>
<iso>FR</iso>
<iso-3166-2>FR-71</iso-3166-2>
<cities></cities>
<children></children>
</child>
<child>
<description>Territoire de Belfort</description>
<type>Departement</type>
<geoId>4214</geoId>
<iso>FR</iso>
<iso-3166-2>FR-90</iso-3166-2>
<cities></cities>
<children></children>
</child>
<child>
<description>Yonne</description>
<type>Departement</type>
<geoId>4213</geoId>
<iso>FR</iso>
<iso-3166-2>FR-89</iso-3166-2>
<cities></cities>
<children></children>
</child>

</children>
</child>


</children>
</location>
</results>
</fcal_api>

CSV

Aufruf:
https://www.feiertagskalender.ch/api/GeoTree/ISO/index.php?api_key=YOUR_API_KEY&iso=FR&format=csv

Antwort des APIs:

"location_L0";"type_L0";"geoId_L0";"iso_L0";"iso-3166-2_L0";"location_L1";"type_L1";"geoId_L1";"iso_L1";"iso-3166-2_L1";"location_L2";"type_L2";"geoId_L2";"location_L3";"type_L3";"geoId_L3";"location_L4";"type_L4";"geoId_L4";"cityName";"cityId"
"Frankreich";"Land";"3079";"FR";"";"";"";"";"";"";"";"";"";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Auvergne-Rhône-Alpes";"Region";"3099";"FR";"FR-ARA";"";"";"";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Auvergne-Rhône-Alpes";"Region";"3099";"FR";"FR-ARA";"Ain";"Departement";"4142";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Auvergne-Rhône-Alpes";"Region";"3099";"FR";"FR-ARA";"Allier";"Departement";"4143";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Auvergne-Rhône-Alpes";"Region";"3099";"FR";"FR-ARA";"Ardèche";"Departement";"4144";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Auvergne-Rhône-Alpes";"Region";"3099";"FR";"FR-ARA";"Cantal";"Departement";"4145";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Auvergne-Rhône-Alpes";"Region";"3099";"FR";"FR-ARA";"Drôme";"Departement";"4146";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Auvergne-Rhône-Alpes";"Region";"3099";"FR";"FR-ARA";"Haute-Loire";"Departement";"4149";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Auvergne-Rhône-Alpes";"Region";"3099";"FR";"FR-ARA";"Haute-Savoie";"Departement";"4154";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Auvergne-Rhône-Alpes";"Region";"3099";"FR";"FR-ARA";"Isère";"Departement";"4147";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Auvergne-Rhône-Alpes";"Region";"3099";"FR";"FR-ARA";"Loire";"Departement";"4148";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Auvergne-Rhône-Alpes";"Region";"3099";"FR";"FR-ARA";"Métropole de Lyon";"Departement";"4152";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Auvergne-Rhône-Alpes";"Region";"3099";"FR";"FR-ARA";"Puy-de-Dôme";"Departement";"4150";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Auvergne-Rhône-Alpes";"Region";"3099";"FR";"FR-ARA";"Rhône";"Departement";"4151";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Auvergne-Rhône-Alpes";"Region";"3099";"FR";"FR-ARA";"Savoie";"Departement";"4153";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Bourgogne-Franche-Comté";"Region";"3101";"FR";"FR-BFC";"";"";"";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Bourgogne-Franche-Comté";"Region";"3101";"FR";"FR-BFC";"Côte-d’Or";"Departement";"4207";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Bourgogne-Franche-Comté";"Region";"3101";"FR";"FR-BFC";"Doubs";"Departement";"4208";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Bourgogne-Franche-Comté";"Region";"3101";"FR";"FR-BFC";"Haute-Saône";"Departement";"4211";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Bourgogne-Franche-Comté";"Region";"3101";"FR";"FR-BFC";"Jura";"Departement";"4209";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Bourgogne-Franche-Comté";"Region";"3101";"FR";"FR-BFC";"Nièvre";"Departement";"4210";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Bourgogne-Franche-Comté";"Region";"3101";"FR";"FR-BFC";"Saône-et-Loire";"Departement";"4212";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Bourgogne-Franche-Comté";"Region";"3101";"FR";"FR-BFC";"Territoire de Belfort";"Departement";"4214";"";"";"";"";"";"";"";""
"Frankreich";"Land";"3079";"FR";"";"Bourgogne-Franche-Comté";"Region";"3101";"FR";"FR-BFC";"Yonne";"Departement";"4213";"";"";"";"";"";"";"";""

Fehlermeldungen

Art der Ausgabe Fehlermeldung Erläuterung
results: status:
results: status: description unknown location Der angeforderte ISO-Ländercode ist nicht bekannt.
Prüfen Sie bitte den Parameter ISO
apiStatus
apiStatus: description invalid usage Die Verwendung dieses API ist für diesen Nutzer nicht freigeschaltet.
apiStatus: description invalid key Ungültiger API-Schlüssel.
apiStatus: description invalid referer Ungültiger Zugriff. Links ab Webseiten (Front-Ends) sind nicht zulässig.
apiStatus: description inactive Das API wurde für noch nicht zur Benutzung freigeschaltet.
apiStatus: description expired Die Nutzungsdauer nach Vertrag ist abgelaufen.
© 2003 - 2025 psc Peter Schütz Informatik Dienstleistungen, CH-Arch