Qualité des nappes d'eau souterraine

2019

05/02/2019 : v1.2.0

• branchement sur la collection solr v2 permettant 1) une mise à jour au fil de l'eau (au même rythme que dans la base ADES) ; 2) la correction du bug pouvant faire varier le nombre de résultats pour une même requête

2018

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

22/01/2018 : version 1.0.1

• correction bug sur l'API analyses
• les paramètres code_groupe_parametre et nom_groupe_parametre fonctionnent

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

L'API "Qualité des nappes d'eaux souterraines" est accessible :

• en http : http://hubeau.eaufrance.fr/api/v1/qualite_nappes/analyses?bss_id=BSS000XUUM&size=20&format=json&pretty
• en https : 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 supporte les protocoles :

• CORS (Cross Origin Resource Sharing)
• JSONP avec le paramètre callback pour les anciens navigateurs : https://hubeau.eaufrance.fr/api/v1/qualite_nappes/analyses?bss_id=BSS000XUUM&size=20&format=json&callback=jquery12&pretty

Les opérations sont paginées et suivent le même modèle de pagination non séquentiel, permettant de sauter d'une page à l'autre de résultats dans n'importe quel ordre. En contre-partie, la profondeur d'accès aux résultats est limitée.

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.

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 à 20 000 enregistrements. Cette limite peut empêcher la récupération de l'intégralité des résultats d'une requête ; il faut alors découper la requête en plusieurs requêtes à l'aide de critères plus discriminants.

Longueur maximale de l'URL
La requête est bloquée si la longueur de l'URL dépasse 2 083 caractères.

L'API "Qualité des nappes d'eaux souterraines" propose différentes opérations :

• l'opération "lister les stations de mesure" (stations) permet d'obtenir la liste des stations de mesure de la qualité des eaux souterraines (ou points d'eau : puits, forages et sources) ;
• l'opération "lister les analyses" (analyses) permet d'obtenir la liste des résultats des analyses, concernant différents paramètres physico-chimiques tels que la conductivité, les nitrates, les substances pesticides, les métaux...

Demande :

Récupérer toutes les analyses de qualité de l'eau du forage ayant pour nouveau code BSS : BSS000XUUM.

URL appelée :

http://hubeau.eaufrance.fr/api/v1/qualite_nappes/analyses?bss_id=BSS000XUUM&size=1000&format=json&pretty
NB. L'attribut pretty permet d'avoir une réponse plus lisible avec des sauts de ligne et une indentation.

Résultats :

Voir les résultats