Documentazione API

Dati annuali

Leggere i dati annuali di diverse località

Dati annuali per tutti i codici postali della Svizzera, inclusi i numeri dei comuni UST

API: Data/Country/CH/PLZ

Capitoli:

API: Data/Country/CH/PLZ

Funzione

Permette di richiedere informazioni per la Svizzera. Fornisce i comuni (compresi i numeri UFS) con le loro vacanze e le vacanze scolastiche per tutti i codici postali, dall'1.01. al 31.12. di un anno.

Attenzione: alcuni codici postali sono assegnati a più comuni, ad esempio il codice postale 1033 è valido per il 91,8% in Cheseaux-sur-Lausanne, 7,8% a Losanna e 0,4% a Crissier. Nei dati, solo i valori per il comune con la quota maggiore.

URL per le richieste

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

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
year
o
jahr

Anno delle date richieste

senza specificazione: anno civile corrente (= standard)

&year= 2023
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 di data desiderato
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

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 Data/Country/CH/PLZ
apiStatus description       Designazione dello stato API. Per le varianti, vedere i Messaggi di errore active
date         Data di esportazione dei dati 06.07.2022
request iso       Codice ISO del paese, 2 cifre CH
  year       Anno dei dati nell'output 2015
  class       Classe della query (riguarda la portata dei dati) 4
  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
  locations location PLZ   Codice postale svizzero 1000
      description   Nome dell'unità geografica Lausanne
      type   Designazione del tipo di unità geografica Comune
      geoId   Geo-ID dell'unità geografica. 2425
      bfsNr   Numero comunità UFS 5586
      iso   Codice ISO del paese, 2 cifre CH
      iso-3166-2   Codice regione secondo ISO 3166-2 CH-VD
      events   Gli eventi del calendario  
        description Designazione della festa, o delle vacanze scolastiche Capodanno
        id ID unica dell'evento. Le feste hanno la stessa ID ogni anno. Le vacanze scolastiche hanno tutti un proprio ID. 1
        dateStart Data Inizio dell'evento 01.01.2015
        dateEnd Data Fine dell'evento 01.01.2015
        class Classe dell'evento:

0 = Vacanze scolastiche
1 = giorno festivo riconosciuto legalmente
2 = è una speciale Domenica
3 = giorno di riposo ufficiale (di solito da mezzogiorno)
4 = giorno festivo non riconosciuto legalmente (negozi, scuole, amministrazioni solitamente chiuse), giorno festivo; ai fini della Convenzione europea sul calcolo dei termini, questo giorno è considerato come un giorno festivo (articolo 5).
5 = Giorno evento
# = parzialmente valido
2
        percent Percentuale di abitanti / classi scolastiche interessate 100
        prov Flag per dati definiti provvisoriamente

0 = sicuramente
1 = provvisorio
0
        note note speciali  

Messaggi di errore

Posizione di uscita Messaggio di errore Spiegazione
results: status:
results: status: description not subscribed Non avete sottoscritto i dati desiderati.
Si prega di contattare il nostro supporto.
apiStatus
apiStatus: description invalid usage L'uso di questa API non è sbloccato per voi.
Si prega di contattare il nostro supporto.
apiStatus: description invalid key Chiave API non valida.
Si prega di controllare la chiave API.
apiStatus: description invalid referer Accesso non valido. Non sono ammessi link da pagine web (front-end).
Impostate la vostra richiesta in modo che provenga da un back-end protetto.
Se necessario, contattare il nostro supporto.
apiStatus: description inactive L'API non è ancora stata abilitata all'uso.
Si prega di riprovare in un secondo momento.
apiStatus: description expired Il periodo di utilizzo secondo il contratto è scaduto.
Contattate la nostra amministrazione per un prolungamento del contratto.

Esempi

JSON

URL:
https://feiertagskalender.ch/api/Data/Country/CH/?api_key=YOUR_API_KEY&jahr=2020&class=5&date_format=d.m.Y

Risposta delle API:

{
	"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": "Data/Country/CH",
	"apiStatus": {
		"description": "active"
	},
	"date": "24.09.2020",
	"request": {
		"iso": "CH",
		"year": "2020",
		"class": "5",
		"charset": "utf-8",
		"format": "json",
		"date_format": "d.m.Y",
		"hl": "de"
	},
	"results": {
		"status": {
			"description": "ok"
		},
		"locations": [{
			"plz": "1000",
			"description": "Lausanne",
			"type": "Gemeinde",
			"geoId": "2425",            
			"bfsNr": "5586",            
			"iso": "CH",
			"iso-3166-2": "CH-VD",
			"events": [{
				"description": "Neujahr",
				"id": "1",
				"dateStart": "01.01.2020",
				"dateEnd": "01.01.2020",
				"class": "2",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Berchtoldstag",
				"id": "3",
				"dateStart": "02.01.2020",
				"dateEnd": "02.01.2020",
				"class": "1",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Valentinstag",
				"id": "27",
				"dateStart": "14.02.2020",
				"dateEnd": "14.02.2020",
				"class": "5",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				...
			}
		}, {
			"plz": "1001",
			"description": "Lausanne",
			"type": "Gemeinde",
			"geoId": "2425",
			"bfsNr": "5586",
			"iso": "CH",
			"iso-3166-2": "CH-VD",
			"events": [{
			...
			}]
		}]
	}
}
					

XML

URL:
https://feiertagskalender.ch/api/Data/Country/CH/?api_key=YOUR_API_KEY&jahr=2020&charset=ISO-8859-1&date_format=d.m.Y&format=xml

Risposta delle API:

<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>Data/Country/CH</apiName>
	<date>24.09.2020</date>
	<request>
		<iso>CH</iso>
		<year>2020</year>
		<class>4</class>
		<charset>ISO-8859-1</charset>
		<format>xml</format>
		<date_format>d.m.Y</date_format>
		<hl>de</hl>
	</request>
	<results>
		<status>
			<description>ok</description>
		</status>
		<locations>
			<location>
                <plz>1000</plz>
                <description>Lausanne</description>
				<type>Gemeinde</type>
				<geoId>2425</geoId>
				<bfsNr>5586</bfsNr>
				<iso>CH</iso>
				<iso-3166-2>CH-VD</iso-3166-2>
				<events>
					<event>
						<description>Neujahr</description>
						<id>1</id>
						<dateStart>01.01.2020</dateStart>
						<dateEnd>01.01.2020</dateEnd>
						<class>1</class>
						<percent>100</percent>
						<prov>0</prov>
						<note></note>
					</event>
					<event>
						<description>Berchtoldstag</description>
						<id>3</id>
						<dateStart>02.01.2020</dateStart>
						<dateEnd>02.01.2020</dateEnd>
						<class>2</class>
						<percent>100</percent>
						<prov>0</prov>
						<note></note>
					</event>
					<event>
						<description>Karfreitag</description>
						<id>17</id>
						<dateStart>10.04.2020</dateStart>
						<dateEnd>10.04.2020</dateEnd>
						<class>2</class>
						<percent>100</percent>
						<prov>0</prov>
						<note></note>
					</event>
                    ...                    
				</events>
			</location>
			<location>            
				<plz>1001</plz>
                <description>Lausanne</description>
				<type>Gemeinde</type>
				<geoId>2425</geoId>
				<bfsNr>5586</bfsNr>
				<iso>CH</iso>
				<iso-3166-2>CH-VD</iso-3166-2>
				<events>				
					...	
				</events>
			</location>
		</locations>
	</results>
</fcal_api>                  

CSV

Aufruf:
https://feiertagskalender.ch/api/Data/Country/CH/PLZ/?api_key=YOUR_API_KEY&jahr=2020&charset=iso-8859-1&format=csv

Risposta delle API:

"plz";location";"geoId";"bfsNr";"iso";"iso_3166_2";"description";"id";"dateStart";"dateEnd";"class";"percent";"prov";"note"
"1000";"Lausanne";"2425";"5586";CH";"CH-VD";"Neujahr";1";"01.01.2020";"01.01.2020";"2";"100";"0";""
"1000";"Lausanne";"2425";"5586";CH";"CH-VD";"Berchtoldstag";3";"02.01.2020";"02.01.2020";"1";"100";"0";""
"1000";"Lausanne";"2425";"5586";CH";"CH-VD";"Karfreitag";17";"10.04.2020";"10.04.2020";"2";"100";"0";""
...
"1001";"Lausanne";"2425";"5586";CH";"CH-VD";"Neujahr";1";"01.01.2020";"01.01.2020";"2";"100";"0";""
...
                
Pagine
Progetti partner
©2003 - 2022 psc Peter Schütz Informatik Dienstleistungen, CH-Bern