search

BRGM / hubeau

Hub'Eau, la plateforme pour manipuler facilement les données ouvertes sur l'eau
65 stars 10 forks source link

Imprécision dans la documentation API Piézo / chroniques_tr #180

Closed tgrandje closed 2 months ago

tgrandje commented 2 months ago

Concernant le code_bss, la documentation indique :

_codebss Code(s) national de la station (anciens codes BSS), si interrogation de plusieurs points d'eau, séparer les codes par une virgule, le nombre maximum de codes est 200 Default value : 07548X0009/F

Le code_bss ne peut manifestement pas être fixé avec une valeur par défaut dans la mesure où il est également possible de fixer un bss_id dans la requête.

Par exemple, la requête https://hubeau.eaufrance.fr/api/v1/niveaux_nappes/chroniques_tr?size=1 retourne un résultat sur un autre piézomètre (00035X0210/PZO1).

Supp-Hubeau commented 2 months ago

Cette valeur par défaut s'applique uniquement à la console et non à l'API en elle-même.

Si aucune valeur n'est saisie dans le formulaire de test, l'URL suivante est générée : https://hubeau.eaufrance.fr/api/v1/niveaux_nappes/chroniques_tr?code_bss=07548X0009%2FF&size=20

Si on saisitbss_id=BSS000ACKJ dans le formulaire de test, l'URL suivante est générée : https://hubeau.eaufrance.fr/api/v1/niveaux_nappes/chroniques_tr?bss_id=BSS000ACKJ&code_bss=07548X0009%2FF&size=20 Il incombe à l'utilisateur de retirer l'un des deux critères lors de ses tests.

L'API en elle-même ne fixe pas de valeur par défaut pour le code ou l'ID BSS. Seul le paramètre size est fixé par défaut (20 dans la console et 5000 au niveau de l'API).

Cordialement, L'équipe Hub'eau