Documentazione API

Dati giornalieri

Leggi lo stato del giorno per data

Informazioni giornaliere per sapere se in questa data ci sono giorni festivi e/o vacanze scolastiche.

API: CheckDate/CH/BFS

Capitoli:

API: CheckDate/CH/BFS

Funzione

Abilita le richieste per data e numero del comune del UST (Ufficio federale di statistica). Indica se e a quale percentuale si applica un giorno festivo in questo giorno, o le vacanze scolastiche.
L'interrogazione funziona anche per i numeri comunali nel Liechtenstein.'

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
BFS
richiesto
Numero del comune svizzero secondo UST (Ufficio federale di statistica) &BFS=371
date

Data dei dati richiesti

senza specifica: oggi (= Standard)

&date=2022-08-06
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 CheckDate/CH/BFS
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: bfs       Numero comunità UFS 371
  date       Data dei dati nell'output 2019-04-15
  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 Bienna
    type     Designazione del tipo di unità geografica Comune
    geoId     Geo-ID dell'unità geografica. 424
    iso     Codice ISO del paese, 2 cifre CH
    iso-3166-2     Codice regione secondo ISO 3166-2 CH-BE
    date_status     Stato del giorno  
      date   Data 2019-04-15
      total_population   Numero totale di abitanti 54640
      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 54640
      school_holiday_percent   Percentuale di popolazione con vacanze scolastiche 100
      school_holiday_description   Designazione Vacanze scolastiche Vacanze di primavera
      sum_population   Numero totale di abitanti interessati 54640
      percent_population   Percentuale di abitanti interessati 100

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.
results: status: description unknown location Il numero del comune UST richiesto non è noto. Si prega di controllare il parametro bfs
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/CheckDate/CH/BFS/?api_key=YOUR_API_KEY&bfs=371&date=2019-04-15

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":"CheckDate/CH/BFS",
   "apiStatus":{
      "description":"active"
   },
   "date":"2022-07-06",
   "request":{
      "bfs":"371",
      "date":"2019-04-15",
      "charset":"utf-8",
      "format":"json",
      "date_format":"Y-m-d",
      "hl":"de"
   },
   "results":{
      "status":{
         "description":"ok"
      },
      "location":{
         "description":"Biel/Bienne",
         "type":"Gemeinde",
         "geoId":"424",
         "iso":"CH",
         "iso-3166-2":"CH-BE",
         "date_status":{
            "date":"2019-04-15",
            "total_population":54640,
            "public_holiday_population":0,
            "public_holiday_percent":0,
            "public_holiday_description":null,
            "school_holiday_population":54640,
            "school_holiday_percent":100,
            "school_holiday_description":"Frühlingsferien",
            "sum_population":54640,
            "sum_percent":100
         }
      }
   }
}
					

XML

URL:
https://feiertagskalender.ch/api/CheckDate/CH/BFS/?api_key=YOUR_API_KEY&bfs=371&date=2019-04-15&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>CheckDate/CH/BFS</apiName>
	<date>2022-07-06</date>
	<request>
		<bfs>371</bfs>
		<date>2019-04-15</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>Biel/Bienne</description>
			<type>Gemeinde</type>
			<geoId>424</geoId>
			<iso>CH</iso>
			<iso-3166-2>CH-BE</iso-3166-2>
			<date_status>
				<date>2019-04-15</date>
				<total_population>54640</total_population>
				<public_holiday_population>0</public_holiday_population>
				<public_holiday_percent>0</public_holiday_percent>
				<public_holiday_description/>
				<school_holiday_population>54640</school_holiday_population>
				<school_holiday_percent>100</school_holiday_percent>
				<school_holiday_description>Frühlingsferien</school_holiday_description>
				<sum_population>54640</sum_population>
				<sum_percent>100</sum_percent>
			</date_status>
		</location>
	</results>
</fcal_api>                  

CSV

URL:
https://feiertagskalender.ch/api/CheckDate/CH/PLZ/?api_key=YOUR_API_KEY&bfs=371&date=2019-04-15&format=csv

Risposta delle API:

"location";"bfs";"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"
"Biel/Bienne";"371";"CH";"CH-BE";"2019-04-15";"54640";"0";"0";"";"54640";"100";"Frühlingsferien";"54640";"100"
Pagine
Progetti partner
©2003 - 2022 psc Peter Schütz Informatik Dienstleistungen, CH-Bern