API Indicateurs des services (ancienne doc)

Derniers changements

2018

22/05/2018 : v0.3.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 : ajout 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

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 "Indicateurs des services d'eau et d'assainissement" sont issues du site SERVICES (Observatoire national des services d'eau et d'assainissement).

Elles portent sur :

Les mises à jour du site SERVICE sont intégrées mensuellement à l'API au premier jour du mois.

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 "Indicateurs des services d'eau et d'assainissement" permet d'accéder aux indicateurs de performance des services publics d'eau et d'assainissement :

  • par commune (opération : lister les services par commune)
  • par service d'eau potable et d'assainissement (opération : lister les services par indicateurs)
  • par service d'eau et d'assainissement pour une commune donnée (opération : lister les services par service)

Accessibilité de l'API

L'API "Indicateurs des services d'eau et d'assainissement" 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/v0/indicateurs_services/services?code_commune=17300&size=3&pretty

{ "count" : 24,
"first" : "http://hubeau.eaufrance.fr/api/v0/indicateurs_services/services?code_com...",
"last" : "http://hubeau.eaufrance.fr/api/v0/indicateurs_services/services?code_com...",
"prev" : null,
"next" : "http://hubeau.eaufrance.fr/api/v0/indicateurs_services/services?code_com...",
"data" : [ { "code_service" : 199694, "nom_service" : "assainissement non collectif", "codes_commune" : [ "17010", "17028", "17059", "17094", "17109", "17136", "17142", "17153", "17190", "17193", "17194", "17200", "17222", "17245", "17264", "17274", "17291", "17300", "17315", "17373", "17391", "17407", "17413", "17414", "17420", "17443", "17466", "17483" ], "noms_commune" : [ "Angoulins", "Aytré", "Bourgneuf", "Châtelaillon-Plage", "Clavette", "Croix-Chapeau", "Dompierre-sur-Mer", "Esnandes", "L' Houmeau", "La Jarne", "La Jarrie", "Lagord", "Marsilly", "Montroy", "Nieul-sur-Mer", "Périgny", "Puilboreau", "La Rochelle", "Saint-Christophe", "Saint-Médard-d'Aunis", "Saint-Rogatien", "Sainte-Soulle", "Saint-Vivien", "Saint-Xandre", "Salles-sur-Mer", "Thairé", "Vérines", "Yves" ], "numero_siren" : "241700434", "type_collectivite" : "Communauté d'agglomération", "mode_gestion" : "régie", "annee" : 2015, "indicateurs" : { "D301.0" : 2800.0, "P301.3" : 78.0395852969, "DC.196" : 110.1, "DC.197" : null, "VP.167" : 1061.0, "VP.166" : 828.0, "VP.168" : 1.0, "VP.169" : 1.0, "VP.230" : 100.0 } },