Documentazione API

Dati giornalieri

API: CheckDate/CityId

Recupera i giorni festivi e le vacanze scolastiche di un intero anno, in base a un `cityId`.

Funzione

Questa API determina se in una data specifica c'è una festività ufficiale o una vacanza scolastica in una località specifica. I parametri richiesti sono `api_key` e `cityId`. Il parametro `date` è opzionale: se non viene specificato, viene automaticamente utilizzata la data odierna. Inoltre, l'output può essere configurato utilizzando altri parametri. I parametri vengono passati come parametri di query nell'URL. In alternativa, l'autorizzazione può avvenire anche nell'intestazione.

I City-ID disponibili si trovano nell'API: GeoTree/ISO


Guida interattiva e OpenAPI aperta

OpenAPI 3.0 (Swagger) – Documentazione API interattiva

Apre la documentazione interattiva dell'API con Swagger, dove è possibile testare ed esplorare gli endpoint dell'API.

Scarica le specifiche JSON di OpenAPI

URL per le richieste

Per recuperare i dati, utilizzare il seguente URL. Si prega di prestare attenzione alle maiuscole e alle minuscole.

POST / GET
https://feiertagskalender.ch/api/CheckDate/CityId/index.php

Parametri per le richieste

Con le seguenti variabili è possibile completare la query e controllare i risultati delle API.

Parametro Spiegazione Esempi
api_key
richiesto
La vostra chiave API api_key=abc-123-def-456
cityId
richiesto
City-ID della località desiderata. Viene utilizzato l'ID città di Feiertagskalender.ch. cityid=88
date

La data da controllare
senza specifica: oggi (= Standard)

date=2025-06-01
class
o
klasse

Portata dei dati

Varianti:
0 = solo vacanze scolastiche
3 = 0 + giorni festivi riconosciuti dalla legge
4 = 0 + 3 + festività pubbliche e non (religiose, culturali) (= Standard)
5 = 0 + 3 + 4 + giorni di evento (ad es. San Valentino, Festa della mamma, Avvento)

klasse=5
charset

La codifica desiderata della risposta

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

charset=iso-8859-1
format

Il formato di uscita desiderato

Varianti:
JSON (= Standard)
XML
CSV

format=xml
date_format

Il formato della data desiderato per la risposta. Standard:`Y-m-d` (ad esempio, 2025-12-31).
Il formato corrisponde alla formattazione della data dell'istruzione PHP date()

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

Lingua desiderata dell'uscita

Varianti:
de = Tedesco (= Standard)
fr = Francese
it = Italiano
en = Inglese

hl=en

Esempi (URL / PHP / Python / JavaScript)

Mostra esempi

Valori di ritorno dell'API

Il contenuto delle risposte API deriva da:
- i dati che hai sottoscritto (paesi, vacanze, vacanze scolastiche, anni solari)
- i dati ufficialmente noti dei legislatori
- la disponibilità in base alle nostre ricerche (situazione effettiva del nostro database)

Si prega di notare che l'output in formato CSV è diverso.

Array         Spiegazione Esempio
interface         Versione dell'API  
source: href       URL della fonte dei dati (sito web)  
  description       Nome della fonte dei dati  
copyright href       URL al titolare del copyright (sito web)  
  description       Designazione del titolare del diritto d'autore  
apiName         Identificazione dell'API CheckDate/CityId
apiStatus description       Designazione dello stato API. Per le varianti, vedere i Messaggi di errore active
date         Data di esportazione dei dati 01.05.2025
request: cityId       City-ID secondo la richiesta 88
  date       Data dei dati nell'output 2019-04-18
  charset       Codifica dei caratteri di output utf-8
  format       Formato dei dati di uscita json
  date_format       Formato data dell'output d.m.Y
  hl       Lingua di emissione, secondo la richiesta it
results status description     Stato dell'output. Per le varianti, vedere i Messaggi di errore ok
  location description     Nome dell'unità geografica Berlin
    type     Designazione del tipo di unità geografica Stadt
    cityId     Geo-ID dell'unità geografica. 89
    iso     Codice ISO del paese, 2 cifre DE
    iso-3166-2     Codice regione secondo ISO 3166-2 DE-BE
    note     Note speciali
    date_status     Stato del giorno  
      date   Data 2019-04-18
      total_population   Numero totale di abitanti 3601131
      public_holiday_population   Numero di abitanti con giorni festivi 0
      public_holiday_percent   Percentuale di abitanti con giorni festivi 0
      public_holiday_description   Designazione della festa
      school_holiday_population   Numero di abitanti con vacanze scolastiche 3601131
      school_holiday_percent   Percentuale di popolazione con vacanze scolastiche 100
      school_holiday_description   Designazione Vacanze scolastiche Osterferien
      sum_population   Numero totale di abitanti interessati 3601131
      percent_population   Percentuale di abitanti interessati 100

Esempi (JSON / XML / CSV)

JSON

URL:
https://www.feiertagskalender.ch/api/CheckDate/CityId/index.php?api_key=YOUR_API_KEY&cityid=89&date=2025-12-25

Risposta delle API:

{
    "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": "CheckDate/CityId",
    "apiStatus": {
        "description": "active"
    },
    "date": "2025-02-25",
    "request": {
        "cityId": "89",
        "date": "2025-12-25",
        "charset": "utf-8",
        "format": "json",
        "date_format": "Y-m-d",
        "hl": "de"
    },
    "results": {
        "status": {
            "description": "ok"
        },
        "location": {
            "description": "Zürich",
            "type": "Stadt",
            "cityId": "89",
            "iso": "CH",
            "iso-3166-2": "CH-ZH",
            "note": "",
            "date_status": {
                "date": "2025-12-25",
                "total_population": 433989,
                "public_holiday_population": 433989,
                "public_holiday_percent": 100,
                "public_holiday_description": "Weihnachten",
                "school_holiday_population": 0,
                "school_holiday_percent": 0,
                "school_holiday_description": null,
                "sum_population": 433989,
                "sum_percent": 100
            }
        }
    }
}

XML

URL:
https://www.feiertagskalender.ch/api/CheckDate/CityId/index.php?api_key=YOUR_API_KEY&cityid=89&date=2025-12-25&format=XML

Risposta delle API:

<fcal_api>
<interface>fcal API 2.01</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/CityId</apiName>
<date>2025-02-25</date>
<request>
<cityId>89</cityId>
<date>2025-12-25</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>Zürich</description>
<type>Stadt</type>
<cityId>89</cityId>
<iso>CH</iso>
<iso-3166-2>CH-ZH</iso-3166-2>
<note></note>
<date_status>
<date>2025-12-25</date>
<total_population>433989</total_population>
<public_holiday_population>433989</public_holiday_population>
<public_holiday_percent>100</public_holiday_percent>
<public_holiday_description>Weihnachten</public_holiday_description>
<school_holiday_population>0</school_holiday_population>
<school_holiday_percent>0</school_holiday_percent>
<school_holiday_description></school_holiday_description>
<sum_population>433989</sum_population>
<sum_percent>100</sum_percent>
</date_status>
</location>
</results>
</fcal_api>

CSV

URL:
https://www.feiertagskalender.ch/api/CheckDate/CityId/index.php?api_key=YOUR_API_KEY&cityid=89&date=2025-12-25&format=CSV

Risposta delle API:

"location";"cityId";"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"
"Zürich";"89";"CH";"CH-ZH";"2025-12-25";"433989";"433989";"100";"Weihnachten";"0";"0";"";"433989";"100"

Messaggi di errore

Posizione di uscita Messaggio di errore Spiegazione
results: status:
results: status: description not subscribed Non avete sottoscritto i dati desiderati.
results: status: description unknown location Il City-ID richiesto non è noto.
apiStatus
apiStatus: description invalid usage L'uso di questa API non è abilitato per questo utente.
apiStatus: description invalid key Chiave API non valida.
apiStatus: description invalid referer Accesso non valido. Non sono ammessi link da pagine web (front-end).
apiStatus: description inactive L'API non è ancora stata attivata per l'uso.
apiStatus: description expired Il periodo di utilizzo secondo il contratto è scaduto.
© 2003 - 2025 psc Peter Schütz Informatik Dienstleistungen, CH-Arch