Qualité de l'eau potable

• 16/11/2022 : version 1
• 29/11/2021 : version beta

Les formats supportés sont : JSON et CSV.

Chaque page renvoie un nombre de résultats égal au paramètre size.

L'API Qualité de l'eau potable utilise un type de pagination non séquentiel qui permet 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.

Un tutoriel sur l'API Qualité des cours d'eau explique, dans la partie Taille des pages de réponse, la mise en oeuvre pratique de la pagination à l'aide d'un cas concret.
Enfin, des exemples de code en Python, R et php sont disponibles dans la partie Exemples de la page de contribution GitHub de Hub'Eau.

2 opérations sont disponibles : 

• communes_udi : permet de faire le lien entre communes et unités de distribution (réseaux). En entrant un code ou nom de commune, récupération de toutes les UDI qui desservent la commune avec indication des noms de quartier ; en entrant un code ou nom de réseau, récupération de toutes les communes et quartiers desservis. 
• resultats_dis : permet de lister les prélèvements, résultats d'analyses et conclusions sanitaires issus du contrôle sanitaire de l'eau distribuée commune par commune. Les réponses sont à la granularité des résultats d'analyse. A noter que les conclusions sanitaires (conclusion_conformite_prelevement, conformite_limites_bact_prelevement, conformite_limites_pc_prelevement, conformite_references_bact_prelevement, conformite_references_pc_prelevement) sont issues au niveau du prélèvement ; elles sont donc répétées autant de fois qu'il y a de résultats d'analyses dans un prélèvement. Pour regrouper par prélèvement, utilisez le champ code_prelevement.

Les champs code_commune et code_reseau permettent de faire le lien entre les deux opérations.

1. Liste des différents réseaux d'alimentation à La Rochelle et historique de leur évolution année par année :

https://hubeau.brgm-rec.fr/api/v1/qualite_eau_potable/communes_udi?nom_commune=rochelle

2. Connaître toutes les communes desservies par le réseau de code 054000006, année par année :

https://hubeau.brgm-rec.fr/api/v1/qualite_eau_potable/communes_udi?code_reseau=054000006

3. Connaître toutes les communes desservies par le réseau de code 054000006 en 2021 :

https://hubeau.brgm-rec.fr/api/v1/qualite_eau_potable/communes_udi?code_reseau=054000006&annee=2021

4. Recherche de tous les résultats d'analyses sur les Nitrates à Orléans :

https://hubeau.brgm-rec.fr/api/v1/qualite_eau_potable/resultats_dis?code_commune=45234&code_parametre=1340

5. Recherche des résultats d'analyses de Nitrates à Orléans où la teneur est supérieure à 10 mg/l, en triant par ordre chronologique et en n'affichant que les paramètres libelle_parametre, code_lieu_analyse, resultat_numerique, libelle_unite et date_prelevement :

https://hubeau.brgm-rec.fr/api/v1/qualite_eau_potable/resultats_dis?code_commune=45234&code_parametre=1340&borne_inf_resultat=10&fields=libelle_parametre,code_lieu_analyse,resultat_numerique,libelle_unite,date_prelevement&sort=asc

6. Connaître la dureté de l'eau à son domicile pour par exemple régler correctement son lave-vaisselle :

Voir https://hubeau.brgm-rec.fr/news/optimisez-la-consommation-de-sel-de-votre-lave-vaisselle-grace-hubeau