API Piézométrie (obsolète)

 

Cette page est obsolète - merci de vous rendre sur la nouvelle page de l'API

 

Derniers changements

2018

25/07/2018 : v1.1.1 et v0.2.1

  • Mise à jour technique

22/05/2018 : v1.1.0

  • ajout d'une limitation sur la profondeur d'accès aux résultats, le calcul de la profondeur = numéro de la page * nombre maximum de résultats dans une page
  • ajout du header "link" pour le format CSV
  • correction code retour pour le format CSV, gère le code 200 et 206

2017

29/11/2017 : mise à jour de la version de l'API : passage de v0 à v1

04/10/2017 : ajout du paramètre "sort" sur l'opération "chroniques", permet de changer l'ordre de tri (asc ou desc) sur la date de mesure piézométrique
04/05/2017 : mise à jour de l'adresse de l'API api.hubeau.fr vers hubeau.eaufrance.fr/api/

2016

24/11/2016 : ajout de l'attribut "timestamp_mesure" sur l'opération "chroniques" de l'API sur le niveau des aquifères
21/09/2016 : ajout des libellés SANDRE à côté des codes SANDRE dans la réponse
08/08/2016 : ajout du paramètre fields, la valeur est une liste des champs souhaités dans la réponse (fonctionnalité expérimentale), par exemple fields=code_station,localisation

Description des données

Les données de l'API "Piézométrie" sont issues du portail ADES (portail national d'accès aux données sur les eaux souterraines).

Elles portent sur les mesures de piézométrie (hauteur d'eau dans le sol), France entière, en provenance de tous les partenaires du système d'information sur l'eau (voir les métadonnées).

Les mises à jour de la banque ADES sont intégrées chaque lundi matin à l'API.

Exposition des données

Les données sont exposées sous la forme d'une API REST.

Les formats supportés sont : JSON, GeoJSON et CSV.

Opérations de l'API

L'API "Piézométrie" propose différentes opérations :

  • l'opération "lister les chroniques piézométriques" permet d'accéder aux chroniques piézométriques (évolution dans le temps du niveau des nappes) par station de mesure
  • l'opération : "lister les stations de mesure" permet d'accéder aux stations de mesure des niveaux des nappes d'eau (piézomètres)

Accessibilité de l'API

L'API "Piézométrie" est accessible :

 

Pour gérer le cross-domain, l'API supporte les protocoles :

Pagination

Les méthodes suivent toutes le même modèle de pagination.

Paramètres

  • page : le numéro de page
  • size : la taille de la page

Attributs

  • Les attributs prev et next (définis à null si il n'y a pas de page précédente et/ou suivante) sont disponibles dans l'URL de la réponse pour éviter d'avoir à calculer les pages précédentes et/ou suivantes
  • L'attribut first permet d'accéder à la première page des résultats,
  • L'attribut last permet d'accéder à la dernière page des résultats,
  • L'attribut count permet de compter le nombre total de résultats,
  • L'attribut data permet d'accéder aux résultats sous forme de liste.

Limitations

Taille de page

Les résultats sont paginés avec une valeur par défaut et une valeur maximum de taille de page pour chaque opération.
Cette valeur est indiquée dans les commentaires de l'opération. Par exemple : "taille de page par défaut : 5000, taille max de la page : 20000."

Profondeur d'accès aux résultats

La profondeur d'accès aux résultats (numéro de la page * nombre maximum de résultats dans une page) est limitée.

Cette limite peut empêcher la récupération de l'intégralité d'une recherche.

Taille de l'URL

La longueur maximale d'une URL est de 2 083 caractères, la requête est bloquée si la limite de longueur est dépassée.

Exemple

http://hubeau.eaufrance.fr/api/v1/niveaux_nappes/stations?code_commune=62193,59094,45234&size=2&format=json&pretty

{ "count" : 7,
"first" : "http://hubeau.eaufrance.fr/api/v1/niveaux_nappes/stations?code_commune=6...",
"last" : "http://hubeau.eaufrance.fr/api/v1/niveaux_nappes/stations?code_commune=6...",
"prev" : null,
"next" : "http://hubeau.eaufrance.fr/api/v1/niveaux_nappes/stations?code_commune=6...",
"data" : [ { "code_bss" : "00026X0040/P1", "urn_bss" : "http://services.ades.eaufrance.fr/pointeau/00026X0040/P1", "date_debut_mesure" : "1970-01-05", "date_fin_mesure" : "2007-05-15", "code_commune_insee" : "62193", "nom_commune" : "CALAIS", "x" : 1.913928133, "y" : 50.96529028, "codes_bdlisa" : [ "101AC01" ], "geometry" : { "type" : "Point", "crs" : { "type" : "name", "properties" : { "name" : "urn:ogc:def:crs:OGC:1.3:CRS84" } }, "coordinates" : [ 1.913928133, 50.96529028 ] }, "urns_bdlisa" : [ "http://reseau.eaufrance.fr/geotraitements/bdlisa/files/entite/101AC01.pdf" ] },