API-Dokumentation

Geografische Daten

Geo-IDs und City-IDs auslesen

Datensets mit dem geografischen Baum.

API: GeoTree/ISO

Kapitel:

API: GeoTree/ISO

Funktion

Ermöglicht Abfragen mittels ISO-Landeskürzel (2-stellig), oder ISO-3166-2 Regionencodes. Gibt den geografischen Baum aus.

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
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

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 19.04.2024
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

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 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/GeoTree/ISO/?api_key=YOUR_API_KEY&iso=BE&cities=1

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":"GeoTree/ISO",
   "apiStatus":{
      "description":"active"
   },
   "date":"2024-04-19",
   "request":{
      "iso":"BE",
      "charset":"utf-8",
      "format":"json",
      "hl":"de"
   },
   "results":{
      "status":{
         "description":"ok"
      },
      "location":{
         "description":"Belgien",
         "type":"Land",
         "geoId":"3285",
         "iso":"BE",
         "iso-3166-2":"",
         "cities":null,
         "children":[
            {
               "description":"Bruxelles",
               "type":"Region",
               "geoId":"3288",
               "iso":"BE",
               "iso-3166-2":"BE-BRU",
               "cities":[
                  {
                     "description":"Brussels",
                     "cityId":"1785"
                  },
                  {
                     "description":"Brussels Airport",
                     "cityId":"23711"
                  }
               ],
               "children":null
            },
            {
               "description":"Flandre",
               "type":"Region",
               "geoId":"3286",
               "iso":"BE",
               "iso-3166-2":"BE-VLG",
               "cities":null,
               "children":[
                  {
                     "description":"Antwerpen",
                     "type":"Provinz",
                     "geoId":"3546",
                     "iso":"BE",
                     "iso-3166-2":"BE-VLG",
                     "cities":[
                        {
                           "description":"Antwerp",
                           "cityId":"2468"
                        },
                        {
                           "description":"Turnhout",
                           "cityId":"25501"
                        }
                     ],
                     "children":null
                  },
                  {
                     "description":"Limburg",
                     "type":"Provinz",
                     "geoId":"3548",
                     "iso":"BE",
                     "iso-3166-2":"BE-VLG",
                     "cities":[
                        {
                           "description":"Hasselt",
                           "cityId":"10377"
                        },
                        {
                           "description":"Maasmechelen",
                           "cityId":"16268"
                        }
                     ],
                     "children":null
                  },
                  {
                     "description":"Oost-Vlaanderen",
                     "type":"Provinz",
                     "geoId":"3545",
                     "iso":"BE",
                     "iso-3166-2":"BE-VLG",
                     "cities":[
                        {
                           "description":"Ghent",
                           "cityId":"2738"
                        }
                     ],
                     "children":null
                  },
                  {
                     "description":"Vlaams-Brabant",
                     "type":"Provinz",
                     "geoId":"3547",
                     "iso":"BE",
                     "iso-3166-2":"BE-VLG",
                     "cities":[
                        {
                           "description":"Leuven",
                           "cityId":"3488"
                        }
                     ],
                     "children":null
                  },
                  {
                     "description":"West-Vlaanderen",
                     "type":"Provinz",
                     "geoId":"3544",
                     "iso":"BE",
                     "iso-3166-2":"BE-VLG",
                     "cities":[
                        {
                           "description":"Bruges",
                           "cityId":"3318"
                        },
                        {
                           "description":"De Panne",
                           "cityId":"3368"
                        },
                        {
                           "description":"Ostend",
                           "cityId":"12368"
                        }
                     ],
                     "children":null
                  }
               ]
            },
            {
               "description":"Wallonnie",
               "type":"Region",
               "geoId":"3287",
               "iso":"BE",
               "iso-3166-2":"BE-WAL",
               "cities":null,
               "children":[
                  {
                     "description":"Henegouwen",
                     "type":"Provinz",
                     "geoId":"3549",
                     "iso":"BE",
                     "iso-3166-2":"BE-WAL",
                     "cities":[
                        {
                           "description":"Charleroi",
                           "cityId":"3348"
                        },
                        {
                           "description":"Endingen",
                           "cityId":"366"
                        },
                        {
                           "description":"Mons",
                           "cityId":"3538"
                        }
                     ],
                     "children":null
                  },
                  {
                     "description":"Luik",
                     "type":"Provinz",
                     "geoId":"3551",
                     "iso":"BE",
                     "iso-3166-2":"BE-WAL",
                     "cities":[
                        {
                           "description":"Ans",
                           "cityId":"12538"
                        },
                        {
                           "description":"Liège",
                           "cityId":"1935"
                        },
                        {
                           "description":"Verviers",
                           "cityId":"11158"
                        }
                     ],
                     "children":null
                  },
                  {
                     "description":"Luxemburg",
                     "type":"Provinz",
                     "geoId":"3553",
                     "iso":"BE",
                     "iso-3166-2":"BE-WAL",
                     "cities":[
                        {
                           "description":"Arlon",
                           "cityId":"10397"
                        },
                        {
                           "description":"Bastogne",
                           "cityId":"8608"
                        },
                        {
                           "description":"Liezen",
                           "cityId":"8618"
                        }
                     ],
                     "children":null
                  },
                  {
                     "description":"Namur",
                     "type":"Provinz",
                     "geoId":"3552",
                     "iso":"BE",
                     "iso-3166-2":"BE-WAL",
                     "cities":[
                        {
                           "description":"Namur",
                           "cityId":"3558"
                        }
                     ],
                     "children":null
                  },
                  {
                     "description":"Waals-Brabant",
                     "type":"Provinz",
                     "geoId":"3550",
                     "iso":"BE",
                     "iso-3166-2":"BE-WAL",
                     "cities":[
                        {
                           "description":"Ottignies-Louvain-la-Neuve",
                           "cityId":"16257"
                        }
                     ],
                     "children":null
                  }
               ]
            }
         ]
      }
   }
}

XML

URL:
https://feiertagskalender.ch/api/GeoTree/ISO/?api_key=YOUR_API_KEY&iso=BE&cities=1&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>GeoTree/ISO</apiName>	
	<date>2024-04-19</date>
	<request>
		<iso>BE</iso>
		<charset>utf-8</charset>
		<format>xml</format>
		<hl>de</hl>
	</request>
	<results>
		<status>
			<description>ok</description>
		</status>
		<location>
			<description>Belgien</description>
			<type>Land</type>
			<geoId>3285</geoId>
			<iso>BE</iso>
			<iso-3166-2></iso-3166-2>
			<cities></cities>
			<children>
				<child>
					<description>Bruxelles</description>
					<type>Region</type>
					<geoId>3288</geoId>
					<iso>BE</iso>
					<iso-3166-2>BE-BRU</iso-3166-2>
					<cities>
						<city>
							<description>Brussels</description>
							<cityId>1785</cityId>
						</city>
					</cities>
					<children></children>
				</child>
				<child>
					<description>Flandre</description>
					<type>Region</type>
					<geoId>3286</geoId>
					<iso>BE</iso>
					<iso-3166-2>BE-VLG</iso-3166-2>
					<cities></cities>
					<children>
						<child>
							<description>Antwerpen</description>
							<type>Provinz</type>
							<geoId>3546</geoId>
							<iso>BE</iso>
							<iso-3166-2>BE-VLG</iso-3166-2>
							<cities>
								<city>
									<description>Antwerp</description>
									<cityId>2468</cityId>
								</city>
							</cities>
							<children></children>
						</child>
						<child>
							<description>Limburg</description>
							<type>Provinz</type>
							<geoId>3548</geoId>
							<iso>BE</iso>
							<iso-3166-2>BE-VLG</iso-3166-2>
							<cities>
								<city>
									<description>Hasselt</description>
									<cityId>10377</cityId>
								</city>
								<city>
									<description>Maasmechelen</description>
									<cityId>16268</cityId>
								</city>
							</cities>
							<children></children>
						</child>
						<child>
							<description>Oost-Vlaanderen</description>
							<type>Provinz</type>
							<geoId>3545</geoId>
							<iso>BE</iso>
							<iso-3166-2>BE-VLG</iso-3166-2>
							<cities>
								<city>
									<description>Ghent</description>
									<cityId>2738</cityId>
								</city>
							</cities>
							<children></children>
						</child>
						<child>
							<description>Vlaams-Brabant</description>
							<type>Provinz</type>
							<geoId>3547</geoId>
							<iso>BE</iso>
							<iso-3166-2>BE-VLG</iso-3166-2>
							<cities>
								<city>
									<description>Leuven</description>
									<cityId>3488</cityId>
								</city>
							</cities>
							<children></children>
						</child>
						<child>
							<description>West-Vlaanderen</description>
							<type>Provinz</type>
							<geoId>3544</geoId>
							<iso>BE</iso>
							<iso-3166-2>BE-VLG</iso-3166-2>
							<cities>
								<city>
									<description>Bruges</description>
									<cityId>3318</cityId>
								</city>
								<city>
									<description>De Panne</description>
									<cityId>3368</cityId>
								</city>
								<city>
									<description>Ostend</description>
									<cityId>12368</cityId>
								</city>
							</cities>
							<children></children>
						</child>
					</children>
				</child>
				<child>
					<description>Wallonnie</description>
					<type>Region</type>
					<geoId>3287</geoId>
					<iso>BE</iso>
					<iso-3166-2>BE-WAL</iso-3166-2>
					<cities></cities>
					<children>
						<child>
							<description>Henegouwen</description>
							<type>Provinz</type>
							<geoId>3549</geoId>
							<iso>BE</iso>
							<iso-3166-2>BE-WAL</iso-3166-2>
							<cities>
								<city>
									<description>Charleroi</description>
									<cityId>3348</cityId>
								</city>
								<city>
									<description>Endingen</description>
									<cityId>366</cityId>
								</city>
								<city>
									<description>Mons</description>
									<cityId>3538</cityId>
								</city>
							</cities>
							<children></children>
						</child>
						<child>
							<description>Luik</description>
							<type>Provinz</type>
							<geoId>3551</geoId>
							<iso>BE</iso>
							<iso-3166-2>BE-WAL</iso-3166-2>
							<cities>
								<city>
									<description>Ans</description>
									<cityId>12538</cityId>
								</city>
								<city>
									<description>Liège</description>
									<cityId>1935</cityId>
								</city>
								<city>
									<description>Verviers</description>
									<cityId>11158</cityId>
								</city>
							</cities>
							<children></children>
						</child>
						<child>
							<description>Luxemburg</description>
							<type>Provinz</type>
							<geoId>3553</geoId>
							<iso>BE</iso>
							<iso-3166-2>BE-WAL</iso-3166-2>
							<cities>
								<city>
									<description>Arlon</description>
									<cityId>10397</cityId>
								</city>
								<city>
									<description>Bastogne</description>
									<cityId>8608</cityId>
								</city>
								<city>
									<description>Liezen</description>
									<cityId>8618</cityId>
								</city>
							</cities>
							<children></children>
						</child>
						<child>
							<description>Namur</description>
							<type>Provinz</type>
							<geoId>3552</geoId>
							<iso>BE</iso>
							<iso-3166-2>BE-WAL</iso-3166-2>
							<cities>
								<city>
									<description>Namur</description>
									<cityId>3558</cityId>
								</city>
							</cities>
							<children></children>
						</child>
						<child>
							<description>Waals-Brabant</description>
							<type>Provinz</type>
							<geoId>3550</geoId>
							<iso>BE</iso>
							<iso-3166-2>BE-WAL</iso-3166-2>
							<cities>
								<city>
									<description>Ottignies-Louvain-la-Neuve</description>
									<cityId>16257</cityId>
								</city>
							</cities>
							<children></children>
						</child>
					</children>
				</child>
			</children>
		</location>
	</results>
</fcal_api>                  

CSV

Aufruf:
https://feiertagskalender.ch/api/GeoTree/ISO/?api_key=YOUR_API_KEY&iso=BE&cities=1&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"
"Belgien";"Land";"3285";"BE";"";"";"";"";"";"";"";"";"";"";"";"";"";"";"";"";""
"Belgien";"Land";"3285";"BE";"";"Bruxelles";"Region";"3288";"BE";"BE-BRU";"";"";"";"";"";"";"";"";"";"";""
"Belgien";"Land";"3285";"BE";"";"Bruxelles";"Region";"3288";"BE";"BE-BRU";"";"";"";"";"";"";"";"";"";"Brussels";"1785"
"Belgien";"Land";"3285";"BE";"";"Flandre";"Region";"3286";"BE";"BE-VLG";"";"";"";"";"";"";"";"";"";"Brussels";"1785"
"Belgien";"Land";"3285";"BE";"";"Flandre";"Region";"3286";"BE";"BE-VLG";"Antwerpen";"Provinz";"3546";"";"";"";"";"";"";"";""
"Belgien";"Land";"3285";"BE";"";"Flandre";"Region";"3286";"BE";"BE-VLG";"Antwerpen";"Provinz";"3546";"";"";"";"";"";"";"Antwerp";"2468"
"Belgien";"Land";"3285";"BE";"";"Flandre";"Region";"3286";"BE";"BE-VLG";"Limburg";"Provinz";"3548";"";"";"";"";"";"";"Antwerp";"2468"
"Belgien";"Land";"3285";"BE";"";"Flandre";"Region";"3286";"BE";"BE-VLG";"Limburg";"Provinz";"3548";"";"";"";"";"";"";"Hasselt";"10377"
"Belgien";"Land";"3285";"BE";"";"Flandre";"Region";"3286";"BE";"BE-VLG";"Limburg";"Provinz";"3548";"";"";"";"";"";"";"Maasmechelen";"16268"
"Belgien";"Land";"3285";"BE";"";"Flandre";"Region";"3286";"BE";"BE-VLG";"Oost-Vlaanderen";"Provinz";"3545";"";"";"";"";"";"";"Maasmechelen";"16268"
"Belgien";"Land";"3285";"BE";"";"Flandre";"Region";"3286";"BE";"BE-VLG";"Oost-Vlaanderen";"Provinz";"3545";"";"";"";"";"";"";"Ghent";"2738"
"Belgien";"Land";"3285";"BE";"";"Flandre";"Region";"3286";"BE";"BE-VLG";"Vlaams-Brabant";"Provinz";"3547";"";"";"";"";"";"";"Ghent";"2738"
"Belgien";"Land";"3285";"BE";"";"Flandre";"Region";"3286";"BE";"BE-VLG";"Vlaams-Brabant";"Provinz";"3547";"";"";"";"";"";"";"Leuven";"3488"
"Belgien";"Land";"3285";"BE";"";"Flandre";"Region";"3286";"BE";"BE-VLG";"West-Vlaanderen";"Provinz";"3544";"";"";"";"";"";"";"Leuven";"3488"
"Belgien";"Land";"3285";"BE";"";"Flandre";"Region";"3286";"BE";"BE-VLG";"West-Vlaanderen";"Provinz";"3544";"";"";"";"";"";"";"Bruges";"3318"
"Belgien";"Land";"3285";"BE";"";"Flandre";"Region";"3286";"BE";"BE-VLG";"West-Vlaanderen";"Provinz";"3544";"";"";"";"";"";"";"De Panne";"3368"
"Belgien";"Land";"3285";"BE";"";"Flandre";"Region";"3286";"BE";"BE-VLG";"West-Vlaanderen";"Provinz";"3544";"";"";"";"";"";"";"Ostend";"12368"
"Belgien";"Land";"3285";"BE";"";"Wallonnie";"Region";"3287";"BE";"BE-WAL";"West-Vlaanderen";"Provinz";"3544";"";"";"";"";"";"";"Ostend";"12368"
"Belgien";"Land";"3285";"BE";"";"Wallonnie";"Region";"3287";"BE";"BE-WAL";"Henegouwen";"Provinz";"3549";"";"";"";"";"";"";"";""
"Belgien";"Land";"3285";"BE";"";"Wallonnie";"Region";"3287";"BE";"BE-WAL";"Henegouwen";"Provinz";"3549";"";"";"";"";"";"";"Charleroi";"3348"
"Belgien";"Land";"3285";"BE";"";"Wallonnie";"Region";"3287";"BE";"BE-WAL";"Henegouwen";"Provinz";"3549";"";"";"";"";"";"";"Mons";"3538"
"Belgien";"Land";"3285";"BE";"";"Wallonnie";"Region";"3287";"BE";"BE-WAL";"Henegouwen";"Provinz";"3549";"";"";"";"";"";"";"Endingen";"366"
"Belgien";"Land";"3285";"BE";"";"Wallonnie";"Region";"3287";"BE";"BE-WAL";"Luik";"Provinz";"3551";"";"";"";"";"";"";"Endingen";"366"
"Belgien";"Land";"3285";"BE";"";"Wallonnie";"Region";"3287";"BE";"BE-WAL";"Luik";"Provinz";"3551";"";"";"";"";"";"";"Liège";"1935"
"Belgien";"Land";"3285";"BE";"";"Wallonnie";"Region";"3287";"BE";"BE-WAL";"Luik";"Provinz";"3551";"";"";"";"";"";"";"Verviers";"11158"
"Belgien";"Land";"3285";"BE";"";"Wallonnie";"Region";"3287";"BE";"BE-WAL";"Luik";"Provinz";"3551";"";"";"";"";"";"";"Ans";"12538"
"Belgien";"Land";"3285";"BE";"";"Wallonnie";"Region";"3287";"BE";"BE-WAL";"Luxemburg";"Provinz";"3553";"";"";"";"";"";"";"Ans";"12538"
"Belgien";"Land";"3285";"BE";"";"Wallonnie";"Region";"3287";"BE";"BE-WAL";"Luxemburg";"Provinz";"3553";"";"";"";"";"";"";"Bastogne";"8608"
"Belgien";"Land";"3285";"BE";"";"Wallonnie";"Region";"3287";"BE";"BE-WAL";"Luxemburg";"Provinz";"3553";"";"";"";"";"";"";"Liezen";"8618"
"Belgien";"Land";"3285";"BE";"";"Wallonnie";"Region";"3287";"BE";"BE-WAL";"Luxemburg";"Provinz";"3553";"";"";"";"";"";"";"Arlon";"10397"
"Belgien";"Land";"3285";"BE";"";"Wallonnie";"Region";"3287";"BE";"BE-WAL";"Namur";"Provinz";"3552";"";"";"";"";"";"";"Arlon";"10397"
"Belgien";"Land";"3285";"BE";"";"Wallonnie";"Region";"3287";"BE";"BE-WAL";"Namur";"Provinz";"3552";"";"";"";"";"";"";"Namur";"3558"
"Belgien";"Land";"3285";"BE";"";"Wallonnie";"Region";"3287";"BE";"BE-WAL";"Waals-Brabant";"Provinz";"3550";"";"";"";"";"";"";"Namur";"3558"
"Belgien";"Land";"3285";"BE";"";"Wallonnie";"Region";"3287";"BE";"BE-WAL";"Waals-Brabant";"Provinz";"3550";"";"";"";"";"";"";"Ottignies-Louvain-la-Neuve";"16257"
                
Seiten
Partnerprojekte
©2003 - 2024 psc Peter Schütz Informatik Dienstleistungen, CH-Bern