Documentation

Cette page décrit l'ensemble des services web permettant d'accéder aux données sur la qualité des nappes d'eau souterraines.

Origine des données

Ces données sont issues de la banque nationale d’Accès aux Données sur les Eaux Souterraines ADES ades.eaufrance.fr ;

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.

Pour plus d'informations sur les conditions d'utilisations, vous pouvez consulter la FAQ et les conditions générales d'utilisations.

Pour vos questions et remarques, utilisez notre forum.

Derniers changements

22/01/2018 : version 1.0.1, correction bug sur l'API analyses, les paramètres code_groupe_parametre et nom_groupe_parametre fonctionnent

Accès

L'API Hub'Eau est accessible en http et https :

http://hubeau.eaufrance.fr/api/v1/qualite_nappes/analyses?bss_id=BSS000XUUM&size=20&format=json&pretty

https://hubeau.eaufrance.fr/api/v1/qualite_nappes/analyses?bss_id=BSS000XUUM&size=20&format=json&pretty

 

Pour gérer le cross-domain, l'API Hub'Eau supporte le protocole Cross Origin Resource Sharing (CORS) et pour les anciens navigateurs le JSONP avec le paramètre callback :

https://hubeau.eaufrance.fr/api/v1/qualite_nappes/analyses?bss_id=BSS000XUUM&size=20&format=json&callback=jquery12&pretty

Pagination

Les méthodes sont paginées et suivent le même modèle de pagination.
Les paramètres de pagination sont :
- page : le numéro de page
- size : la taille de la page

Vous n'avez pas à calculer vous-même les pages précédentes et suivantes puisque les URL sont disponible dans la réponse dans les attributs prev et next. Ils seront définis à null si il n'y a pas de page précédente et/ou suivante.
L'attribut first permet d'accéder à la 1er page des résultats, l'attribut last permet d'accéder à la dernière page des résultats et l'attribut count le nombre total de résultat.
Les résultats sous forme de liste sont dans l'attribut data.

Limitations

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 information est indiqué dans les commentaires de l'opération, exemple :
"La taille de page par défaut : 5000, taille max de la page : 20000."

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

Exemple

http://hubeau.eaufrance.fr/api/v1/qualite_nappes/analyses?bss_id=BSS000XUUM&size=20&format=json&pretty


{ "count" : 771,
"first" : "http://hubeau.eaufrance.fr/api/v1/qualite_nappes/analyses?bss_id=BSS000X...",
"last" : "http://hubeau.eaufrance.fr/api/v1/qualite_nappes/analyses?bss_id=BSS000X...",
"prev" : null,
"next" : "http://hubeau.eaufrance.fr/api/v1/qualite_nappes/analyses?bss_id=BSS000X...", "api_version" : "1.0.0", "data" : [ { "bss_id" : "BSS000XUUM", "code_bss" : "03195X0015/HY", "urn_bss" : "http://services.ades.eaufrance.fr/pointeau/BSS000XUUM", "longitude" : -1.076111596, "latitude" : 48.081871278, "code_insee_actuel" : "35217", "nom_commune_actuel" : "PERTRE(LE)", "num_departement" : "35", "nom_departement" : "ILLE-ET-VILAINE", "code_region" : "REG53", "nom_region" : "BRETAGNE", "code_circonscription_administrative_bassin" : "04", "nom_circonscription_administrative_bassin" : "LOIRE-BRETAGNE", "code_bassin_dce" : "G", "nom_bassin_dce" : "La Loire, les cours d'eau côtiers vendéens et bretons", "urn_bassin_dce" : "http://www.sandre.eaufrance.fr/geo/BassinDCE/FRG", "code_type_point_eau" : 2, "nom_type_point_eau" : "qualitometre", "codes_entite_hg_bdlisa" : [ "174AA01" ], "noms_entite_hg_bdlisa" : [ "Socle métamorphique dans les bassins versants de la Vilaine, la Seiche et le Don de leurs sources à la mer" ], "urns_bdlisa" : [ "http://reseau.eaufrance.fr/geotraitements/bdlisa/files/entite/174AA01.pdf" ], "codes_masse_eau_rap" : [ "GG015" ], "noms_masse_eau_rap" : [ "Vilaine" ], "urns_masse_eau_rap" : [ "http://www.sandre.eaufrance.fr/geo/MasseDEauSouterraine/GG015" ], "codes_masse_eau_edl" : [ "GG015" ], "noms_masse_eau_edl" : [ "Bassin versant de la Vilaine" ], "urns_masse_eau_edl" : [ "http://www.sandre.eaufrance.fr/geo/MasseDEauSouterraine/GG015" ], "codes_reseau" : [ "0000000028" ], "noms_reseau" : [ "Réseau national de suivi au titre du contrôle sanitaire sur les eaux brutes utilisées pour la production d'eau potable" ], "uris_reseau" : [ "http://id.eaufrance.fr/dc/0000000028" ], "code_type_qualito" : 1, "nom_type_qualito" : "Point d'eau unique", "uri_type_qualito" : "http://id.eaufrance.fr/nsa/161#1", "code_producteur" : "35", "nom_producteur" : "Direction Départementale des Affaires Sanitaires et Sociales (D.D.A.S.S.) de l'Ille-et-Vilaine", "uri_producteur" : "http://id.eaufrance.fr/int/35", "date_debut_prelevement" : "1983-05-18", "code_param" : 1316, "nom_param" : "Oxydabilité au KMnO4 à chaud en milieu alcalin", "uri_param" : "http://id.eaufrance.fr/par/1316", "code_fraction" : 23, "nom_fraction" : "Eau brute", "uri_fraction" : "http://id.eaufrance.fr/fan/23", "resultat" : 2.0, "code_remarque_analyse" : 1, "nom_remarque_analyse" : "Résultat > seuil de quantification et < au seuil de saturation ou Résultat = 0", "uri_remarque_analyse" : "http://id.eaufrance.fr/nsa/155#23", "code_lieu_analyse" : 2, "nom_lieu_analyse" : "Laboratoire", "uri_lieu_analyse" : "http://id.eaufrance.fr/nsa/156#2", "code_methode" : 0, "nom_methode" : "Méthode inconnue", "uri_methode" : "http://id.eaufrance.fr/met/0", "code_unite" : "175", "nom_unite" : "milligramme d'oxygène par litre", "symbole_unite" : "mg(O2)/L", "uri_unite" : "http://id.eaufrance.fr/urf/175", "code_statut_analyse" : "2", "nom_statut_analyse" : "Donnée contrôlée niveau 1", "uri_statut_analyse" : "http://id.eaufrance.fr/nsa/416#2", "code_qualification" : "1", "nom_qualification" : "Correcte", "uri_qualification" : "http://id.eaufrance.fr/nsa/414#1", "limite_quantification" : null, "limite_detection" : null, "seuil_saturation" : null, "incertitude_analytique" : null, "codes_groupe_parametre" : [ "43", "41", "31" ], "noms_groupe_parametre" : [ "Indices globaux (AOX, DCO,…)", "Chimique", "Paramètres classés par classe" ], "uris_groupe_parametre" : [ "http://id.eaufrance.fr/gpr/43", "http://id.eaufrance.fr/gpr/41", "http://id.eaufrance.fr/gpr/31" ] } ] }