Documentation de l'API

Données quotidiennes

Lire le statut du jour par date

Informations quotidiennes indiquant s'il y a un jour férié et/ou des vacances scolaires à cette date.

API: CheckDate/CH/PLZ

Chapitres :

API: CheckDate/CH/PLZ

Fonction

Permet d'effectuer des recherches par date et par code postal suisse. Indique s'il y a un jour férié ou des vacances scolaires ce jour-là et à quel pourcentage.
La requête fonctionne également pour les codes postaux du 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
PLZ
requis
Code postal suisse &PLZ=2504
date

Date des données demandées

sans spécification : aujourd'hui (= standard)

&date=2021-11-24
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 CheckDate/CH/PLZ
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: plz       Code postal suisse 2504
  date       Date des données dans la sortie 2019-04-15
  charset       Codage de la police de la sortie utf-8
  format       Format des données de la sortie json
  date_format       Format de la date de la sortie d.m.Y
  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 Ville
    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
    date_status     Statut du jour  
      date   Date 2019-04-15
      total_population   Nombre total d'habitants 54640
      public_holiday_population   Nombre d'habitants ayant un jour férié 0
      public_holiday_percent   Pourcentage d'habitants ayant un jour férié 0
      public_holiday_description   Désignation du jour férié
      school_holiday_population   Nombre d'habitants ayant des vacances scolaires 54640
      school_holiday_percent   Pourcentage de la population ayant des vacances scolaires 100
      school_holiday_description   Désignation Vacances scolaires Vacances de printemps
      sum_population   Nombre total d'habitants concernés 54640
      percent_population   Pourcentage d'habitants touchés 100

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.
Le code postal suisse demandé n'est pas connu.
Veuillez vérifier le paramètre PLZ..
results: status: description unknown location Le code postal suisse demandé n'est pas connu.
Veuillez vérifier le paramètre PLZ..
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/CheckDate/CH/PLZ/?api_key=YOUR_API_KEY&plz=2504&date=2019-04-15

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":"CheckDate/CH/PLZ",
   "apiStatus":{
      "description":"active"
   },
   "date":"2021-10-24",
   "request":{
      "plz":"2504",
      "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/PLZ/?api_key=YOUR_API_KEY&plz=2504&date=2019-04-15&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>CheckDate/CH/PLZ</apiName>
	<date>2019-04-11</date>
	<request>
		<plz>2504</plz>
		<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&plz=2504&date=2019-04-15&format=csv

Réponse de l'API :

"location";"plz";"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";"2504";"CH";"CH-BE";"2019-04-15";"54640";"0";"0";"";"54640";"100";"Frühlingsferien";"54640";"100"
Pages
Projets de partenaire
©2003 - 2021 psc Peter Schütz Informatik Dienstleistungen, CH-Bern