API Qualité des cours d'eau (obsolète)

 

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

 

Derniers changements

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

26/02/2018 : mise à jour de la version de l'API, passage de v0 à v1

  • modification de l'URL de l'API : /v0/qualite_rivieres par /v1/qualite_rivieres (pour plus d'information : http://hubeau.eaufrance.fr/page/api-qualite-cours-deau-depreciee)

2017

  • 29/11/2017 : ajout de dans la réponse de l'attribut api_version (string) : version de l'API (https://semver.org/)
  • 04/05/2017 : mise à jour de l'adresse de l'API api.hubeau.fr vers hubeau.eaufrance.fr/api/

2016

 

  • 25/10/2016 : ajout des données qualité des rivières de l'agence de l'eau Loire Bretagne
  • 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, par exemple fields=code_station,localisation

Description des données

Les données de l'API "Qualité des cours d'eau" sont issues de la base Naïades.

Disponibles sur la France entière (y compris les DROM), elles portent sur les résultats des mesures de la qualité des cours d’eau et des plans d’eau (données physico-chimiques) effectuées par les Agences de l'Eau.

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 "Qualité des cours d'eau" propose différentes opérations :

  • l'opération "lister les stations de mesure physico-chimiques"  (station_pc) permet d'accéder à la liste des stations (lieux de mesure) sur les cours d'eau ou plans d'eau où des prélèvements d'eau ont eu lieu en vue de faire des analyses de la qualité de l'eau
  • l'opération "lister les opérations physico-chimiques" (operation_pc) permet d'accéder à la liste des opérations de prélèvement ayant eu lieu sur les stations
  • l'opération "lister les conditions environnementales" (condition_environnementale_pc) permet d'accéder à la liste des conditions environnementales (température de l'air, présence de feuilles, mousses, irisations, etc) observées lors des opérations de prélèvements physico-chimiques
  • l'opération "lister les analyses physico-chimiques" (analyse_pc) permet d'accéder à la liste des analyses physico-chimiques effectuées sur les échantillons confectionnés lors des opérations de prélèvement sur les différentes stations. Ces analyses concernent des paramètres physico-chimiques tels que : conductivité, nitrates, substances pesticides, métaux lourds...)

Accessibilité de l'API

L'API "Qualité des cours d'eau" 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

https://hubeau.eaufrance.fr/api/v1/qualite_rivieres/station_pc?code_commune=17300,17299&size=3&pretty

{ "count" : 7, "first" : "http://hubeau.eaufrance.fr/api/v1/qualite_rivieres/station_pc?code_commune=17300,17299&pretty&page=1&size=3", "last" : "http://hubeau.eaufrance.fr/api/v1/qualite_rivieres/station_pc?code_commune=17300,17299&pretty&page=3&size=3", "prev" : null, "next" : "http://hubeau.eaufrance.fr/api/v1/qualite_rivieres/station_pc?code_commune=17300,17299&pretty&page=2&size=3", "api_version" : "1.0.0", "data" : [ { "code_station" : "04782000", "libelle_station" : "CANAL DE MARANS LA ROCHELLE À LA ROCHELLE", "uri_station" : "http://id.eaufrance.fr/STQ/04782000", "durete" : null, "coordonnee_x" : 380106.0, "coordonnee_y" : 6570510.0, "code_projection" : "26", "libelle_projection" : "RGF93 / Lambert 93", "longitude" : -1.147241678, "latitude" : 46.158788107, "code_commune" : "17300", "libelle_commune" : "LA ROCHELLE", "code_departement" : "17", "libelle_departement" : "CHARENTE-MARITIME", "code_region" : "75", "libelle_region" : "NOUVELLE-AQUITAINE", "code_cours_eau" : "N8--300G", "nom_cours_eau" : null, "uri_cours_eau" : "http://id.eaufrance.fr/CEA/N8--300G", "code_masse_deau" : "GR0925", "code_eu_masse_deau" : "FRGR0925", "nom_masse_deau" : "CANAUX DE MARANS", "uri_masse_deau" : "http://id.eaufrance.fr/MDO/GR0925", "code_eu_sous_bassin" : "FRG_LACV", "nom_sous_bassin" : "Loire aval et côtiers vendéens", "code_bassin" : "G", "code_eu_bassin" : "FRG", "nom_bassin" : "La Loire, les cours d'eau côtiers vendéens et bretons", "uri_bassin" : "http://id.eaufrance.fr/SEH/G", "type_entite_hydro" : "2", "commentaire" : null, "date_creation" : "1900-01-01", "date_arret" : null, "date_maj_information" : "2011-03-31", "finalite" : "Inconnue", "localisation_precise" : "AMONT ECLUSE VIEUX PORT", "nature" : "M", "altitude_point_caracteristique" : 0.0, "point_kilometrique" : 999654.0, "premier_mois_annee_etiage" : null, "superficie_bassin_versant_reel" : null, "superficie_bassin_versant_topo" : null, "geometry" : { "type" : "Point", "crs" : { "type" : "name", "properties" : { "name" : "urn:ogc:def:crs:OGC:1.3:CRS84" } }, "coordinates" : [ -1.14724167760006, 46.1587881072281 ] } }, { "code_station" : "04782008", "libelle_station" : "CANAL DE MARANS A LA ROCHELLE A LA ROCHELLE", "uri_station" : "http://id.eaufrance.fr/STQ/04782008", "durete" : null, "coordonnee_x" : 379854.3, "coordonnee_y" : 6570462.0, "code_projection" : "26", "libelle_projection" : "RGF93 / Lambert 93", "longitude" : -1.150466139, "latitude" : 46.158237437, "code_commune" : "17300", "libelle_commune" : "LA ROCHELLE", "code_departement" : "17", "libelle_departement" : "CHARENTE-MARITIME", "code_region" : "75", "libelle_region" : "NOUVELLE-AQUITAINE", "code_cours_eau" : "N8--300G", "nom_cours_eau" : null, "uri_cours_eau" : "http://id.eaufrance.fr/CEA/N8--300G", "code_masse_deau" : "GR0925", "code_eu_masse_deau" : "FRGR0925", "nom_masse_deau" : "CANAUX DE MARANS", "uri_masse_deau" : "http://id.eaufrance.fr/MDO/GR0925", "code_eu_sous_bassin" : "FRG_LACV", "nom_sous_bassin" : "Loire aval et côtiers vendéens", "code_bassin" : "G", "code_eu_bassin" : "FRG", "nom_bassin" : "La Loire, les cours d'eau côtiers vendéens et bretons", "uri_bassin" : "http://id.eaufrance.fr/SEH/G", "type_entite_hydro" : "2", "commentaire" : null, "date_creation" : "1900-01-01", "date_arret" : null, "date_maj_information" : "2012-06-21", "finalite" : "Inconnue", "localisation_precise" : "AMONT PORTE MAUBEC", "nature" : "M", "altitude_point_caracteristique" : 0.0, "point_kilometrique" : 999917.0, "premier_mois_annee_etiage" : null, "superficie_bassin_versant_reel" : null, "superficie_bassin_versant_topo" : null, "geometry" : { "type" : "Point", "crs" : { "type" : "name", "properties" : { "name" : "urn:ogc:def:crs:OGC:1.3:CRS84" } }, "coordinates" : [ -1.1504661394648, 46.158237437234 ] } }, { "code_station" : "04782009", "libelle_station" : "CANAL DE LA MOULINETTE A LA ROCHELLE", "uri_station" : "http://id.eaufrance.fr/STQ/04782009", "durete" : null, "coordonnee_x" : 380618.9, "coordonnee_y" : 6569977.0, "code_projection" : "26", "libelle_projection" : "RGF93 / Lambert 93", "longitude" : -1.140242433, "latitude" : 46.154237383, "code_commune" : "17300", "libelle_commune" : "LA ROCHELLE", "code_departement" : "17", "libelle_departement" : "CHARENTE-MARITIME", "code_region" : "75", "libelle_region" : "NOUVELLE-AQUITAINE", "code_cours_eau" : "N8205000", "nom_cours_eau" : null, "uri_cours_eau" : "http://id.eaufrance.fr/CEA/N8205000", "code_masse_deau" : null, "code_eu_masse_deau" : null, "nom_masse_deau" : null, "uri_masse_deau" : null, "code_eu_sous_bassin" : null, "nom_sous_bassin" : null, "code_bassin" : null, "code_eu_bassin" : null, "nom_bassin" : null, "uri_bassin" : null, "type_entite_hydro" : "2", "commentaire" : null, "date_creation" : "1900-01-01", "date_arret" : null, "date_maj_information" : "2012-06-21", "finalite" : "Inconnue", "localisation_precise" : "AMONT BARRAGE", "nature" : "M", "altitude_point_caracteristique" : 0.0, "point_kilometrique" : 999701.0, "premier_mois_annee_etiage" : null, "superficie_bassin_versant_reel" : null, "superficie_bassin_versant_topo" : null, "geometry" : { "type" : "Point", "crs" : { "type" : "name", "properties" : { "name" : "urn:ogc:def:crs:OGC:1.3:CRS84" } }, "coordinates" : [ -1.14024243310643, 46.1542373829939 ] } } ] }