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/CityId

Chapitres :

API: CheckDate/CityId

Fonction

Permet d'effectuer des recherches via le City-ID (ID de Feiertagskalender.ch) et la date. Indique si et à quel pourcentage un jour férié s'applique ce jour-là, ou les vacances scolaires.

Les City-ID disponibles se trouvent dans l'API : GeoTree/ISO

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
cityId
requis
City-ID de la localité souhaitée. La City-ID de Feiertagskalender.ch &cityid=88
date

Date des données demandées
sans spécification : aujourd'hui (= standard)

&date=2024-05-20
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/CityId
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 20.04.2024
request: cityId       City-ID selon la demande 88
  date       Date des données dans la sortie 2019-04-18
  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 Berlin
    type     Désignation du type d'unité géographique Stadt
    cityId     Géo-ID de l'unité géographique. 88
    iso     Code pays ISO, 2 chiffres DE
    iso-3166-2     Code de région selon la norme ISO 3166-2 DE-BE
    note     Notes spéciales NOUVEAU 30.03.2023
    date_status     Statut du jour  
      date   Date 2019-04-18
      total_population   Nombre total d'habitants 3601131
      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 3601131
      school_holiday_percent   Pourcentage de la population ayant des vacances scolaires 100
      school_holiday_description   Désignation Vacances scolaires Osterferien
      sum_population   Nombre total d'habitants concernés 3601131
      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.
results: status: description unknown location La City-ID demandée n'est pas connue.
Veuillez vérifier le paramètre cityId
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/CityId/?api_key=YOUR_API_KEY&cityId=88&date=2019-04-18

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/CityId",
   "apiStatus":{
      "description":"active"
   },
   "date":"2024-04-20",
   "request":{
      "cityId":"88",
      "date":"2019-04-18",
      "charset":"utf-8",
      "format":"json",
      "date_format":"Y-m-d",
      "hl":"de"
   },
   "results":{
      "status":{
         "description":"ok"
      },
      "location":{
         "description":"Berlin",
         "type":"Stadt",
         "cityId":"88",
         "iso":"DE",
         "iso-3166-2":"DE-BE",
         "date_status":{
            "date":"2019-04-18",
            "total_population":3601131,
            "public_holiday_population":0,
            "public_holiday_percent":0,
            "public_holiday_description":null,
            "school_holiday_population":3601131,
            "school_holiday_percent":100,
            "school_holiday_description":"Osterferien",
            "sum_population":3601131,
            "sum_percent":100
         }
      }
   }
}
					

XML

URL :
https://feiertagskalender.ch/api/CheckDate/CityId/?api_key=YOUR_API_KEY&charset=iso-8859-1&cityId=88&date=2019-04-18&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/CityId</apiName>
	<date>2024-04-20</date>
	<request>
		<cityId>88</cityId>
		<date>2019-04-18</date>
		<charset>iso-8859-1</charset>
		<format>xml</format>
		<date_format>Y-m-d</date_format>
		<hl>de</hl>
	</request>
	<results>
		<status>
			<description>ok</description>
		</status>
		<location>
			<description>Berlin</description>
			<type>Stadt</type>
			<cityId>88</cityId>
			<iso>DE</iso>
			<iso-3166-2>DE-BE</iso-3166-2>
			<date_status>
				<date>2019-04-18</date>
				<total_population>3601131</total_population>
				<public_holiday_population>0</public_holiday_population>
				<public_holiday_percent>0</public_holiday_percent>
				<public_holiday_description></public_holiday_description>
				<school_holiday_population>3601131</school_holiday_population>
				<school_holiday_percent>100</school_holiday_percent>
				<school_holiday_description>Osterferien</school_holiday_description>
				<sum_population>3601131</sum_population>
				<sum_percent>100</sum_percent>
			</date_status>
		</location>
	</results>
</fcal_api>                  

CSV

URL :
view-source:https://feiertagskalender.ch/api/CheckDate/CityId/?api_key=YOUR_API_KEY&cityId=88&date=2019-04-18&charset=iso-8859-1&format=csv

Réponse de l'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"
"Berlin";"88";"DE";"DE-BE";"2019-04-18";"3601131";"0";"0";"";"3601131";"100";"Osterferien";"3601131";"100"
Pages
Projets de partenaire
©2003 - 2024 psc Peter Schütz Informatik Dienstleistungen, CH-Bern