Documentation de l'API

Données annuelles

Lire des données annuelles pour 1 site

Ensembles de données avec les vacances et les congés scolaires d'une année.

API: Data/CH/BFS

Chapitres :

API: Data/CH/BFS

Fonction

Permet d'effectuer des recherches en utilisant le numéro de commune de l'OFS, Office fédéral de la statistique. Produit les données de l'année civile (jours fériés et vacances scolaires) du 1.01. - 31.12. d'une année.
La requête fonctionne également pour les numéros de commune au Liechtenstein.

URL pour les requêtes

Pour récupérer les données, utilisez l'URL suivante. Veuillez faire attention aux majuscules et aux minuscules.

Paramètres des requêtes

Les variables suivantes vous permettent de compléter la requête et de contrôler les résultats de l'API.

Paramètre Explication Exemples
api_key
requis

Votre clé API

?api_key=abc-123-def-456
BFS
requis
Numéro de la commune suisse selon l'OFS (Office fédéral de la statistique) &BFS=371
year
oubièn
jahr

Année des dates demandées

sans précision : année civile en cours (= standard)

&year= 2022
class
oubièn
klasse

Portée des données

Variantes :
0 = vacances scolaires uniquement
3 = 0 + jours fériés reconnus par la loi
4 = 0 + 3 + jours fériés (religieux, culturels) et non fériés (= standard)
5 = 0 + 3 + 4 + jours d'événements (par exemple, le Saint-Valentin, la fête des mères, les dimanches de l'Avent))

&klasse=5
charset

Le codage souhaité de la réponse

Variantes :
UTF-8 (= standard)
ISO-8859-1

&charset=iso-8859-1
format

Le format de sortie souhaité

Variantes :
JSON (= standard)
XML
CSV

&format=xml
date_format

Le format de date souhaité
Le format correspond au formatage de la date de l'instruction PHP date()

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

Langue de sortie souhaitée

Variantes :
de = Allemand (= standard)
fr = Français
it = Italien
en = Anglais

&hl=en

Valeurs de retour de l'API

Le contenu des réponses de l'API résulte de :
- les données auxquelles vous avez souscrit (pays, vacances, congés scolaires, années civiles)
- les données officiellement connues des législateurs
- la disponibilité en fonction de nos recherches (situation réelle de notre base de données)

Veuillez noter que la version en format CSV diffère.

Array         Explication Exemple
interface         Version de l'API  
source: href       URL de la source de données (site web)  
  description       Nom de la source des données  
copyright href       URL du titulaire du droit d'auteur (site web)  
  description       Désignation du titulaire du droit d'auteur  
apiName         Identification de l'API Data/CH/BFS
apiStatus description       Désignation du statut de l'API. Pour les variantes, voir les Messages d'erreur active
date         Date d'exportation des données 24.10.2021
request: bfs       N° OFS de la commune 371
  year       Année des données dans la production 2015
  class       Classe de la requête (concerne l'étendue des données) 4
  charset       Codage de la police de la sortie utf-8
  format       Format des données de la sortie json
  hl       Langue de délivrance, selon la demande fr
results status description     Statut de la confirmation. Pour les variantes, voir les Messages d'erreur ok
  location description     Nom de l'unité géographique Bienne
    type     Désignation du type d'unité géographique Stadt
    geoId     Géo-ID de l'unité géographique. 424
    iso     Code pays ISO, 2 chiffres CH
    iso-3166-2     Code de région selon la norme ISO 3166-2 CH-BE
    events     Les événements du calendrier  
      description   Désignation du jour férié, ou des vacances scolaires Nouvel an
      id   ID unique de l'événement.
Les jours fériés ont la même ID chaque année.
Les vacances scolaires ont toutes leur propre ID.
1
      dateStart   Date Début de l'événement 01.01.2015
      dateEnd   Date Fin de l'événement 01.01.2015
      class   Classe de l'événement :

0 = Vacances scolaires
1 = jour férié légalement reconnu
2 = Jour férié assimilé au dimanche
3 = demi-jour férié légal (généralement à partir de midi)
4 = jour férié non reconnu par la loi (magasins, écoles, administrations habituellement fermés), jour férié ; aux fins de la Convention européenne sur le calcul des délais, ce jour est traité comme un jour férié (article 5).
5 = Événement
# = partiellement valable
2
      percent   Pourcentage d'habitants / de classes d'école touchés 100
      prov   Indicateur pour les données définies provisoirement

0 = définitivement
1 = provisoire
0
      note   notes spéciales  

Messages d'erreur

Emplacement de la sortie Message d'erreur Explication
results: status:
results: status: description not subscribed Vous n'avez pas souscrit aux données souhaitées.
Veuillez contacter notre service de soutien.
results: status: description unknown location Le numéro de la municipalité FSO demandé n'est pas connu.
Veuillez vérifier le paramètre bfs
apiStatus
apiStatus: description invalid usage L'utilisation de cette API n'est pas débloquée pour vous.
Veuillez contacter notre service de soutien.
apiStatus: description invalid key Clé API invalide.
Veuillez vérifier votre clé API.
apiStatus: description invalid referer Accès non valable. Les liens à partir de pages web (front-ends) ne sont pas autorisés.
Configurez votre requête de manière à ce qu'elle provienne d'un back-end protégé.
Si nécessaire, contactez notre support.
apiStatus: description inactive L'API n'a pas encore été activée pour que vous puissiez l'utiliser.
Veuillez réessayer plus tard.
apiStatus: description expired La période d'utilisation prévue par le contrat a expiré.
Contactez notre administration pour une prolongation de contrat.

Exemples

JSON

URL :
https://feiertagskalender.ch/api/Data/CH/BFS/?api_key=YOUR_API_KEY&jahr=2015&date_format=d.m.Y&BFS=371

Réponse de l'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/CH/BFS",
	"apiStatus": {
		"description": "active"
	},
	"date": "04.08.2017",
	"request": {
		"bfs": "371",
		"year": "2015",
		"class": "4",
		"charset": "utf-8",
		"format": "json",
		"hl": "de"
	},
	"results": {
		"status": {
			"description": "ok"
		}, {
		"location": {
			"description": "Biel/Bienne",
			"type": "Gemeinde",
			"geoId": "424",
			"iso": "CH",
			"iso-3166-2": "CH-BE",
			"events": [{
				"description": "Neujahrstag",
				"id": "1",
				"dateStart": "01.01.2015",
				"dateEnd": "01.01.2015",
				"class": "2",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Berchtoldstag",
				"id": "3",
				"dateStart": "02.01.2015",
				"dateEnd": "02.01.2015",
				"class": "2",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Karfreitag",
				"id": "17",
				"dateStart": "03.04.2015",
				"dateEnd": "03.04.2015",
				"class": "2",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Ostern",
				"id": "18",
				"dateStart": "05.04.2015",
				"dateEnd": "05.04.2015",
				"class": "4",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Ostermontag",
				"id": "19",
				"dateStart": "06.04.2015",
				"dateEnd": "06.04.2015",
				"class": "2",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Auffahrt",
				"id": "31",
				"dateStart": "14.05.2015",
				"dateEnd": "14.05.2015",
				"class": "2",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Pfingsten",
				"id": "30",
				"dateStart": "24.05.2015",
				"dateEnd": "24.05.2015",
				"class": "4",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Pfingstmontag",
				"id": "35",
				"dateStart": "25.05.2015",
				"dateEnd": "25.05.2015",
				"class": "2",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Nationalfeiertag Schweiz",
				"id": "12",
				"dateStart": "01.08.2015",
				"dateEnd": "01.08.2015",
				"class": "2",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Weihnachten",
				"id": "23",
				"dateStart": "25.12.2015",
				"dateEnd": "25.12.2015",
				"class": "2",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Stephanstag",
				"id": "37",
				"dateStart": "26.12.2015",
				"dateEnd": "26.12.2015",
				"class": "2",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Winterferien",
				"id": "214542",
				"dateStart": "20.12.2014",
				"dateEnd": "4.01.2015",
				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Sportferien",
				"id": "271745",
				"dateStart": "7.02.2015",
				"dateEnd": "15.02.2015",
				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Fr\u00fchlingsferien",
				"id": "214543",
				"dateStart": "3.04.2015",
				"dateEnd": "19.04.2015",
				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Tag der Arbeit",
				"id": "294008",
				"dateStart": "1.05.2015",
				"dateEnd": "1.05.2015",
				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Auffahrtsferien",
				"id": "277391",
				"dateStart": "14.05.2015",
				"dateEnd": "17.05.2015",
				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Pfingstferien",
				"id": "277392",
				"dateStart": "25.05.2015",
				"dateEnd": "25.05.2015",
				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Sommerferien",
				"id": "271746",
				"dateStart": "4.07.2015",
				"dateEnd": "16.08.2015",
				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Herbstferien",
				"id": "294005",
				"dateStart": "3.10.2015",
				"dateEnd": "18.10.2015",
				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}, {
				"description": "Winterferien",
				"id": "214546",
				"dateStart": "19.12.2015",
				"dateEnd": "3.01.2016",
				"class": "0",
				"percent": "100",
				"prov": "0",
				"note": null
			}]
		}
	}
}					

XML

URL :
https://feiertagskalender.ch/api/Data/CH/BFS/?api_key=YOUR_API_KEY&charset=iso-8859-1&date_format=d.m.Y&BFS=371&jahr=2015&format=xml

Réponse de l'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/CH/BFS</apiName>
	<date>04.08.2017</date>
	<request>
		<bfs>371</bfs>
		<year>2015</year>
		<class>4</class>
		<charset>utf-8</charset>
		<format>xml</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>
			<events>
				<event>
					<description>Neujahrstag</description>
					<id>1</id>
					<dateStart>01.01.2015</dateStart>
					<dateEnd>01.01.2015</dateEnd>
					<class>2</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Berchtoldstag</description>
					<id>3</id>
					<dateStart>02.01.2015</dateStart>
					<dateEnd>02.01.2015</dateEnd>
					<class>2</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Karfreitag</description>
					<id>17</id>
					<dateStart>03.04.2015</dateStart>
					<dateEnd>03.04.2015</dateEnd>
					<class>2</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Ostern</description>
					<id>18</id>
					<dateStart>05.04.2015</dateStart>
					<dateEnd>05.04.2015</dateEnd>
					<class>4</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Ostermontag</description>
					<id>19</id>
					<dateStart>06.04.2015</dateStart>
					<dateEnd>06.04.2015</dateEnd>
					<class>2</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Auffahrt</description>
					<id>31</id>
					<dateStart>14.05.2015</dateStart>
					<dateEnd>14.05.2015</dateEnd>
					<class>2</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Pfingsten</description>
					<id>30</id>
					<dateStart>24.05.2015</dateStart>
					<dateEnd>24.05.2015</dateEnd>
					<class>4</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Pfingstmontag</description>
					<id>35</id>
					<dateStart>25.05.2015</dateStart>
					<dateEnd>25.05.2015</dateEnd>
					<class>2</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Nationalfeiertag Schweiz</description>
					<id>12</id>
					<dateStart>01.08.2015</dateStart>
					<dateEnd>01.08.2015</dateEnd>
					<class>2</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Weihnachten</description>
					<id>23</id>
					<dateStart>25.12.2015</dateStart>
					<dateEnd>25.12.2015</dateEnd>
					<class>2</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Stephanstag</description>
					<id>37</id>
					<dateStart>26.12.2015</dateStart>
					<dateEnd>26.12.2015</dateEnd>
					<class>2</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Winterferien</description>
					<id>214542</id>
					<dateStart>20.12.2014</dateStart>
					<dateEnd>4.01.2015</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Sportferien</description>
					<id>271745</id>
					<dateStart>7.02.2015</dateStart>
					<dateEnd>15.02.2015</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Frühlingsferien</description>
					<id>214543</id>
					<dateStart>3.04.2015</dateStart>
					<dateEnd>19.04.2015</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Tag der Arbeit</description>
					<id>294008</id>
					<dateStart>1.05.2015</dateStart>
					<dateEnd>1.05.2015</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Auffahrtsferien</description>
					<id>277391</id>
					<dateStart>14.05.2015</dateStart>
					<dateEnd>17.05.2015</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Pfingstferien</description>
					<id>277392</id>
					<dateStart>25.05.2015</dateStart>
					<dateEnd>25.05.2015</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Sommerferien</description>
					<id>271746</id>
					<dateStart>4.07.2015</dateStart>
					<dateEnd>16.08.2015</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Herbstferien</description>
					<id>294005</id>
					<dateStart>3.10.2015</dateStart>
					<dateEnd>18.10.2015</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
				<event>
					<description>Winterferien</description>
					<id>214546</id>
					<dateStart>19.12.2015</dateStart>
					<dateEnd>3.01.2016</dateEnd>
					<class>0</class>
					<percent>100</percent>
					<prov>0</prov>
					<note></note>
				</event>
			</events>
		</location>
	</results>
</fcal_api>                  

CSV

URL :
https://feiertagskalender.ch/api/Data/CH/BFS/?api_key=YOUR_API_KEY&charset=iso-8859-1&date_format=d.m.Y&BFS=371&jahr=2015&format=csv

Réponse de l'API :

"location";"bfs";"description";"id";"dateStart";"dateEnd";"class";"percent";"prov";"note"
"Biel/Bienne";"371";"Neujahrstag";"1";"01.01.2015";"01.01.2015";"2";"100";"0";""
"Biel/Bienne";"371";"Berchtoldstag";"3";"02.01.2015";"02.01.2015";"2";"100";"0";""
"Biel/Bienne";"371";"Karfreitag";"17";"03.04.2015";"03.04.2015";"2";"100";"0";""
"Biel/Bienne";"371";"Ostern";"18";"05.04.2015";"05.04.2015";"4";"100";"0";""
"Biel/Bienne";"371";"Ostermontag";"19";"06.04.2015";"06.04.2015";"2";"100";"0";""
"Biel/Bienne";"371";"Auffahrt";"31";"14.05.2015";"14.05.2015";"2";"100";"0";""
"Biel/Bienne";"371";"Pfingsten";"30";"24.05.2015";"24.05.2015";"4";"100";"0";""
"Biel/Bienne";"371";"Pfingstmontag";"35";"25.05.2015";"25.05.2015";"2";"100";"0";""
"Biel/Bienne";"371";"Nationalfeiertag Schweiz";"12";"01.08.2015";"01.08.2015";"2";"100";"0";""
"Biel/Bienne";"371";"Weihnachten";"23";"25.12.2015";"25.12.2015";"2";"100";"0";""
"Biel/Bienne";"371";"Stephanstag";"37";"26.12.2015";"26.12.2015";"2";"100";"0";""
"Biel/Bienne";"371";"Winterferien";"214542";"20.12.2014";"4.01.2015";"0";"100";"0";""
"Biel/Bienne";"371";"Sportferien";"271745";"7.02.2015";"15.02.2015";"0";"100";"0";""
"Biel/Bienne";"371";"Frühlingsferien";"214543";"3.04.2015";"19.04.2015";"0";"100";"0";""
"Biel/Bienne";"371";"Tag der Arbeit";"294008";"1.05.2015";"1.05.2015";"0";"100";"0";""
"Biel/Bienne";"371";"Auffahrtsferien";"277391";"14.05.2015";"17.05.2015";"0";"100";"0";""
"Biel/Bienne";"371";"Pfingstferien";"277392";"25.05.2015";"25.05.2015";"0";"100";"0";""
"Biel/Bienne";"371";"Sommerferien";"271746";"4.07.2015";"16.08.2015";"0";"100";"0";""
"Biel/Bienne";"371";"Herbstferien";"294005";"3.10.2015";"18.10.2015";"0";"100";"0";""
"Biel/Bienne";"371";"Winterferien";"214546";"19.12.2015";"3.01.2016";"0";"100";"0";""