{ "openapi": "3.0.0", "info": { "title": "Feiertagskalender API", "description": "This API reads the geographical tree of a country or region. This allows the geoIds required for further queries to be determined. The required parameters are `api_key` and `iso`. In addition, the output can be configured using further parameters. The parameters are passed as query parameters in the URL. Alternatively, authorisation can also take place in the header.

**CSV note:** The CSV output contains a flat table structure in which nested JSON\/XML elements are not mapped. Some data fields are not available in CSV format.", "version": "0.9.0" }, "servers": [ { "url": "https:\/\/feiertagskalender.ch\/api" } ], "paths": { "\/GeoTree\/ISO\/index.php": { "get": { "tags": [ "Geographical data" ], "summary": "Get the geopraphic tree for all available entries of a country, based on an ISO country code (iso). (query parameter)", "description": "**GeoTree\/ISO**
This API reads the geographical tree of a country or region. This allows the geoIds required for further queries to be determined. The required parameters are `api_key` and `iso`. In addition, the output can be configured using further parameters. The parameters are passed as query parameters in the URL. Alternatively, authorisation can also take place in the header.\n\t\t\t\t

**Note:** The geographical tree contains all entries that result from the need to display public holidays and school holidays correctly. There is also a separate city database with additional cities that are located within our tree structure. The parameter `cities` (0\/1) can be used to specify whether the city database should be included in the output of the geographical tree.", "parameters": [ { "name": "api_key", "in": "query", "required": true, "description": "Your API Key", "schema": { "type": "string" } }, { "name": "iso", "in": "query", "required": true, "description": "ISO country code, 2 digits, or Region code according to ISO 3166-2", "schema": { "type": "string" } }, { "name": "cities", "in": "query", "required": false, "description": "Flag for extended export with the recorded cities:\r\n- `0` = without cities (default)\r\n- `1` = with cities", "schema": { "type": "integer", "enum": [ 0, 1 ], "default": 0 } }, { "name": "charset", "in": "query", "required": false, "description": "The desired coding of the response", "schema": { "type": "string", "enum": [ "utf-8", "iso-8859-1" ], "default": "utf-8" } }, { "name": "format", "in": "query", "required": false, "description": "The desired output format", "schema": { "type": "string", "enum": [ "json", "xml", "csv" ], "default": "json" } }, { "name": "hl", "in": "query", "required": false, "description": "Desired language of the output", "schema": { "type": "string", "enum": [ "de", "en", "fr", "it" ], "default": "de" } } ], "responses": { "200": { "description": "Successful response with the query results. The CSV output contains a flat table structure in which nested JSON\/XML elements are not mapped. Please note that some data fields are not available in CSV format. \n\n**JSON-Request:**\n`https:\/\/feiertagskalender.ch\/api\/GeoTree\/ISO\/index.php?api_key=YOUR_API_KEY&iso=FR&hl=de`\n\n**XML-Request:**\n`https:\/\/feiertagskalender.ch\/api\/GeoTree\/ISO\/index.php?api_key=YOUR_API_KEY&iso=FR&hl=de&format=XML`\n\n**CSV-Request:**\n`https:\/\/feiertagskalender.ch\/api\/GeoTree\/ISO\/index.php?api_key=YOUR_API_KEY&iso=FR&hl=de&format=CSV`\n\n", "content": { "application\/json": { "example": { "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 } ] } ] } } } }, "application\/xml": { "schema": { "type": "object", "xml": { "name": "fcal_api" } }, "example": "\r\nfcal API 2.02<\/interface>\r\n\r\nhttps:\/\/feiertagskalender.ch<\/href>\r\nfeiertagskalender.ch<\/description>\r\n<\/source>\r\n\r\nhttps:\/\/psc.ch<\/href>\r\npsc Peter Schuetz Informatik-Dienstleistungen, CH Bern<\/description>\r\n<\/copyright>\r\n\r\nactive<\/description>\r\n<\/apiStatus>\r\nGeoTree\/ISO<\/apiName>\r\n2025-02-28<\/date>\r\n\r\nFR<\/iso>\r\nutf-8<\/charset>\r\nxml<\/format>\r\nde<\/hl>\r\n<\/request>\r\n\r\n\r\nok<\/description>\r\n<\/status>\r\n\r\nFrankreich<\/description>\r\nLand<\/type>\r\n3079<\/geoId>\r\nFR<\/iso>\r\n<\/iso-3166-2>\r\n<\/cities>\r\n\r\n\r\nAuvergne-Rhône-Alpes<\/description>\r\nRegion<\/type>\r\n3099<\/geoId>\r\nFR<\/iso>\r\nFR-ARA<\/iso-3166-2>\r\n<\/cities>\r\n\r\n\r\nAin<\/description>\r\nDepartement<\/type>\r\n4142<\/geoId>\r\nFR<\/iso>\r\nFR-01<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nAllier<\/description>\r\nDepartement<\/type>\r\n4143<\/geoId>\r\nFR<\/iso>\r\nFR-03<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nArdèche<\/description>\r\nDepartement<\/type>\r\n4144<\/geoId>\r\nFR<\/iso>\r\nFR-07<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nCantal<\/description>\r\nDepartement<\/type>\r\n4145<\/geoId>\r\nFR<\/iso>\r\nFR-15<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nDrôme<\/description>\r\nDepartement<\/type>\r\n4146<\/geoId>\r\nFR<\/iso>\r\nFR-26<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nHaute-Loire<\/description>\r\nDepartement<\/type>\r\n4149<\/geoId>\r\nFR<\/iso>\r\nFR-43<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nHaute-Savoie<\/description>\r\nDepartement<\/type>\r\n4154<\/geoId>\r\nFR<\/iso>\r\nFR-74<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nIsère<\/description>\r\nDepartement<\/type>\r\n4147<\/geoId>\r\nFR<\/iso>\r\nFR-38<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nLoire<\/description>\r\nDepartement<\/type>\r\n4148<\/geoId>\r\nFR<\/iso>\r\nFR-42<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nMétropole de Lyon<\/description>\r\nDepartement<\/type>\r\n4152<\/geoId>\r\nFR<\/iso>\r\nFR-69<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nPuy-de-Dôme<\/description>\r\nDepartement<\/type>\r\n4150<\/geoId>\r\nFR<\/iso>\r\nFR-63<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nRhône<\/description>\r\nDepartement<\/type>\r\n4151<\/geoId>\r\nFR<\/iso>\r\nFR-69<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nSavoie<\/description>\r\nDepartement<\/type>\r\n4153<\/geoId>\r\nFR<\/iso>\r\nFR-73<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\n<\/children>\r\n<\/child>\r\n\r\nBourgogne-Franche-Comté<\/description>\r\nRegion<\/type>\r\n3101<\/geoId>\r\nFR<\/iso>\r\nFR-BFC<\/iso-3166-2>\r\n<\/cities>\r\n\r\n\r\nCôte-d’Or<\/description>\r\nDepartement<\/type>\r\n4207<\/geoId>\r\nFR<\/iso>\r\nFR-21<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nDoubs<\/description>\r\nDepartement<\/type>\r\n4208<\/geoId>\r\nFR<\/iso>\r\nFR-25<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nHaute-Saône<\/description>\r\nDepartement<\/type>\r\n4211<\/geoId>\r\nFR<\/iso>\r\nFR-70<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nJura<\/description>\r\nDepartement<\/type>\r\n4209<\/geoId>\r\nFR<\/iso>\r\nFR-39<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nNièvre<\/description>\r\nDepartement<\/type>\r\n4210<\/geoId>\r\nFR<\/iso>\r\nFR-58<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nSaône-et-Loire<\/description>\r\nDepartement<\/type>\r\n4212<\/geoId>\r\nFR<\/iso>\r\nFR-71<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nTerritoire de Belfort<\/description>\r\nDepartement<\/type>\r\n4214<\/geoId>\r\nFR<\/iso>\r\nFR-90<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nYonne<\/description>\r\nDepartement<\/type>\r\n4213<\/geoId>\r\nFR<\/iso>\r\nFR-89<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\n<\/children>\r\n<\/child>\r\n\r\n\r\n<\/children>\r\n<\/location>\r\n<\/results>\r\n<\/fcal_api>" }, "application\/csv": { "example": "\"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\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Ain\";\"Departement\";\"4142\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Allier\";\"Departement\";\"4143\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Ardèche\";\"Departement\";\"4144\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Cantal\";\"Departement\";\"4145\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Drôme\";\"Departement\";\"4146\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Haute-Loire\";\"Departement\";\"4149\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Haute-Savoie\";\"Departement\";\"4154\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Isère\";\"Departement\";\"4147\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Loire\";\"Departement\";\"4148\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Métropole de Lyon\";\"Departement\";\"4152\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Puy-de-Dôme\";\"Departement\";\"4150\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Rhône\";\"Departement\";\"4151\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Savoie\";\"Departement\";\"4153\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Bourgogne-Franche-Comté\";\"Region\";\"3101\";\"FR\";\"FR-BFC\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Bourgogne-Franche-Comté\";\"Region\";\"3101\";\"FR\";\"FR-BFC\";\"Côte-d’Or\";\"Departement\";\"4207\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Bourgogne-Franche-Comté\";\"Region\";\"3101\";\"FR\";\"FR-BFC\";\"Doubs\";\"Departement\";\"4208\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Bourgogne-Franche-Comté\";\"Region\";\"3101\";\"FR\";\"FR-BFC\";\"Haute-Saône\";\"Departement\";\"4211\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Bourgogne-Franche-Comté\";\"Region\";\"3101\";\"FR\";\"FR-BFC\";\"Jura\";\"Departement\";\"4209\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Bourgogne-Franche-Comté\";\"Region\";\"3101\";\"FR\";\"FR-BFC\";\"Nièvre\";\"Departement\";\"4210\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Bourgogne-Franche-Comté\";\"Region\";\"3101\";\"FR\";\"FR-BFC\";\"Saône-et-Loire\";\"Departement\";\"4212\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Bourgogne-Franche-Comté\";\"Region\";\"3101\";\"FR\";\"FR-BFC\";\"Territoire de Belfort\";\"Departement\";\"4214\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Bourgogne-Franche-Comté\";\"Region\";\"3101\";\"FR\";\"FR-BFC\";\"Yonne\";\"Departement\";\"4213\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"" } } }, "400": { "description": "Incorrect request - missing or invalid parameters.", "content": { "application\/json": { "examples": { "not subscribed": { "summary": "You have not subscribed to the desired data.", "value": { "results": { "status": { "description": "not subscribed" } } } }, "unknown_location": { "summary": "The requested ISO country code is not known.
Please check the parameter ISO<\/strong>", "value": { "results": { "status": { "description": "unknown location" } } } } } } } }, "403": { "description": "Access denied - Invalid API key.", "content": { "application\/json": { "examples": { "invalid_key": { "summary": "Invalid API key.", "value": { "apiStatus": { "description": "invalid key" } } }, "invalid_usage": { "summary": "The use of this API is not enabled for this user.", "value": { "apiStatus": { "description": "invalid usage" } } }, "invalid_referer": { "summary": "Invalid access. Links from web pages (front-ends) are not allowed.", "value": { "apiStatus": { "description": "invalid referer" } } }, "inactive": { "summary": "The API has not yet been activated for use.", "value": { "apiStatus": { "description": "inactive" } } }, "expired": { "summary": "The period of use according to the contract has expired.", "value": { "apiStatus": { "description": "expired" } } } } } } }, "500": { "description": "Interner Serverfehler – ein unerwarteter Fehler ist aufgetreten.", "content": { "application\/json": { "example": { "error": { "code": 500, "message": "Interner Serverfehler. Bitte versuchen Sie es später erneut." } } } } } } }, "post": { "tags": [ "Geographical data" ], "summary": "Get the geopraphic tree for all available entries of a country, based on an ISO country code (iso). ((JSON request)", "description": "**GeoTree\/ISO**
This API reads the geographical tree of a country or region. This allows the geoIds required for further queries to be determined. The required parameters are `api_key` and `iso`. The output can also be configured using additional parameters. The parameters are transferred as JSON in the request body. Alternatively, authorisation can also take place in the header. \n\t\t\t\t

**Note:** The geographical tree contains all entries that result from the need to display public holidays and school holidays correctly. There is also a separate city database with additional cities that are located within our tree structure. The parameter `cities` (0\/1) can be used to specify whether the city database should be included in the output of the geographical tree.", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "api_key": { "type": "string" }, "iso": { "type": "string" }, "cities": { "type": "integer", "enum": [ 0, 1 ], "default": 0 }, "charset": { "type": "string", "enum": [ "utf-8", "iso-8859-1" ], "default": "utf-8" }, "format": { "type": "string", "enum": [ "json", "xml", "csv" ], "default": "json" }, "hl": { "type": "string", "enum": [ "de", "fr", "it", "en" ], "default": "de" } }, "required": [ "api_key", "iso" ] }, "example": { "api_key": "YOUR_API_KEY", "iso": "FR", "cities": "0", "charset": "utf-8", "format": "json", "hl": "de" } } } }, "responses": { "200": { "description": "Successful response with the query results. The CSV output contains a flat table structure in which nested JSON\/XML elements are not mapped. Please note that some data fields are not available in CSV format.", "content": { "application\/json": { "example": { "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 } ] } ] } } } }, "application\/xml": { "schema": { "type": "object", "xml": { "name": "fcal_api" } }, "example": "\r\nfcal API 2.02<\/interface>\r\n\r\nhttps:\/\/feiertagskalender.ch<\/href>\r\nfeiertagskalender.ch<\/description>\r\n<\/source>\r\n\r\nhttps:\/\/psc.ch<\/href>\r\npsc Peter Schuetz Informatik-Dienstleistungen, CH Bern<\/description>\r\n<\/copyright>\r\n\r\nactive<\/description>\r\n<\/apiStatus>\r\nGeoTree\/ISO<\/apiName>\r\n2025-02-28<\/date>\r\n\r\nFR<\/iso>\r\nutf-8<\/charset>\r\nxml<\/format>\r\nde<\/hl>\r\n<\/request>\r\n\r\n\r\nok<\/description>\r\n<\/status>\r\n\r\nFrankreich<\/description>\r\nLand<\/type>\r\n3079<\/geoId>\r\nFR<\/iso>\r\n<\/iso-3166-2>\r\n<\/cities>\r\n\r\n\r\nAuvergne-Rhône-Alpes<\/description>\r\nRegion<\/type>\r\n3099<\/geoId>\r\nFR<\/iso>\r\nFR-ARA<\/iso-3166-2>\r\n<\/cities>\r\n\r\n\r\nAin<\/description>\r\nDepartement<\/type>\r\n4142<\/geoId>\r\nFR<\/iso>\r\nFR-01<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nAllier<\/description>\r\nDepartement<\/type>\r\n4143<\/geoId>\r\nFR<\/iso>\r\nFR-03<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nArdèche<\/description>\r\nDepartement<\/type>\r\n4144<\/geoId>\r\nFR<\/iso>\r\nFR-07<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nCantal<\/description>\r\nDepartement<\/type>\r\n4145<\/geoId>\r\nFR<\/iso>\r\nFR-15<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nDrôme<\/description>\r\nDepartement<\/type>\r\n4146<\/geoId>\r\nFR<\/iso>\r\nFR-26<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nHaute-Loire<\/description>\r\nDepartement<\/type>\r\n4149<\/geoId>\r\nFR<\/iso>\r\nFR-43<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nHaute-Savoie<\/description>\r\nDepartement<\/type>\r\n4154<\/geoId>\r\nFR<\/iso>\r\nFR-74<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nIsère<\/description>\r\nDepartement<\/type>\r\n4147<\/geoId>\r\nFR<\/iso>\r\nFR-38<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nLoire<\/description>\r\nDepartement<\/type>\r\n4148<\/geoId>\r\nFR<\/iso>\r\nFR-42<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nMétropole de Lyon<\/description>\r\nDepartement<\/type>\r\n4152<\/geoId>\r\nFR<\/iso>\r\nFR-69<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nPuy-de-Dôme<\/description>\r\nDepartement<\/type>\r\n4150<\/geoId>\r\nFR<\/iso>\r\nFR-63<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nRhône<\/description>\r\nDepartement<\/type>\r\n4151<\/geoId>\r\nFR<\/iso>\r\nFR-69<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nSavoie<\/description>\r\nDepartement<\/type>\r\n4153<\/geoId>\r\nFR<\/iso>\r\nFR-73<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\n<\/children>\r\n<\/child>\r\n\r\nBourgogne-Franche-Comté<\/description>\r\nRegion<\/type>\r\n3101<\/geoId>\r\nFR<\/iso>\r\nFR-BFC<\/iso-3166-2>\r\n<\/cities>\r\n\r\n\r\nCôte-d’Or<\/description>\r\nDepartement<\/type>\r\n4207<\/geoId>\r\nFR<\/iso>\r\nFR-21<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nDoubs<\/description>\r\nDepartement<\/type>\r\n4208<\/geoId>\r\nFR<\/iso>\r\nFR-25<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nHaute-Saône<\/description>\r\nDepartement<\/type>\r\n4211<\/geoId>\r\nFR<\/iso>\r\nFR-70<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nJura<\/description>\r\nDepartement<\/type>\r\n4209<\/geoId>\r\nFR<\/iso>\r\nFR-39<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nNièvre<\/description>\r\nDepartement<\/type>\r\n4210<\/geoId>\r\nFR<\/iso>\r\nFR-58<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nSaône-et-Loire<\/description>\r\nDepartement<\/type>\r\n4212<\/geoId>\r\nFR<\/iso>\r\nFR-71<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nTerritoire de Belfort<\/description>\r\nDepartement<\/type>\r\n4214<\/geoId>\r\nFR<\/iso>\r\nFR-90<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\nYonne<\/description>\r\nDepartement<\/type>\r\n4213<\/geoId>\r\nFR<\/iso>\r\nFR-89<\/iso-3166-2>\r\n<\/cities>\r\n<\/children>\r\n<\/child>\r\n\r\n<\/children>\r\n<\/child>\r\n\r\n\r\n<\/children>\r\n<\/location>\r\n<\/results>\r\n<\/fcal_api>" }, "application\/csv": { "example": "\"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\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Ain\";\"Departement\";\"4142\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Allier\";\"Departement\";\"4143\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Ardèche\";\"Departement\";\"4144\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Cantal\";\"Departement\";\"4145\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Drôme\";\"Departement\";\"4146\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Haute-Loire\";\"Departement\";\"4149\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Haute-Savoie\";\"Departement\";\"4154\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Isère\";\"Departement\";\"4147\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Loire\";\"Departement\";\"4148\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Métropole de Lyon\";\"Departement\";\"4152\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Puy-de-Dôme\";\"Departement\";\"4150\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Rhône\";\"Departement\";\"4151\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Auvergne-Rhône-Alpes\";\"Region\";\"3099\";\"FR\";\"FR-ARA\";\"Savoie\";\"Departement\";\"4153\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Bourgogne-Franche-Comté\";\"Region\";\"3101\";\"FR\";\"FR-BFC\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Bourgogne-Franche-Comté\";\"Region\";\"3101\";\"FR\";\"FR-BFC\";\"Côte-d’Or\";\"Departement\";\"4207\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Bourgogne-Franche-Comté\";\"Region\";\"3101\";\"FR\";\"FR-BFC\";\"Doubs\";\"Departement\";\"4208\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Bourgogne-Franche-Comté\";\"Region\";\"3101\";\"FR\";\"FR-BFC\";\"Haute-Saône\";\"Departement\";\"4211\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Bourgogne-Franche-Comté\";\"Region\";\"3101\";\"FR\";\"FR-BFC\";\"Jura\";\"Departement\";\"4209\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Bourgogne-Franche-Comté\";\"Region\";\"3101\";\"FR\";\"FR-BFC\";\"Nièvre\";\"Departement\";\"4210\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Bourgogne-Franche-Comté\";\"Region\";\"3101\";\"FR\";\"FR-BFC\";\"Saône-et-Loire\";\"Departement\";\"4212\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Bourgogne-Franche-Comté\";\"Region\";\"3101\";\"FR\";\"FR-BFC\";\"Territoire de Belfort\";\"Departement\";\"4214\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"\r\n\"Frankreich\";\"Land\";\"3079\";\"FR\";\"\";\"Bourgogne-Franche-Comté\";\"Region\";\"3101\";\"FR\";\"FR-BFC\";\"Yonne\";\"Departement\";\"4213\";\"\";\"\";\"\";\"\";\"\";\"\";\"\";\"\"" } } }, "400": { "description": "Incorrect request - missing or invalid parameters.", "content": { "application\/json": { "examples": { "not subscribed": { "summary": "You have not subscribed to the desired data.", "value": { "results": { "status": { "description": "not subscribed" } } } }, "unknown_location": { "summary": "The requested ISO country code is not known.
Please check the parameter ISO<\/strong>", "value": { "results": { "status": { "description": "unknown location" } } } } } } } }, "403": { "description": "Access denied - Invalid API key.", "content": { "application\/json": { "examples": { "invalid_key": { "summary": "Invalid API key.", "value": { "apiStatus": { "description": "invalid key" } } }, "invalid_usage": { "summary": "The use of this API is not enabled for this user.", "value": { "apiStatus": { "description": "invalid usage" } } }, "invalid_referer": { "summary": "Invalid access. Links from web pages (front-ends) are not allowed.", "value": { "apiStatus": { "description": "invalid referer" } } }, "inactive": { "summary": "The API has not yet been activated for use.", "value": { "apiStatus": { "description": "inactive" } } }, "expired": { "summary": "The period of use according to the contract has expired.", "value": { "apiStatus": { "description": "expired" } } } } } } }, "500": { "description": "Interner Serverfehler – ein unerwarteter Fehler ist aufgetreten.", "content": { "application\/json": { "example": { "error": { "code": 500, "message": "Interner Serverfehler. Bitte versuchen Sie es später erneut." } } } } } } } } } }