Recherche d’épisodes¶
Description¶
Ce web-service permet de rechercher des épisodes.
Paramètres HTTP¶
Paramètre |
Valeur |
|---|---|
Route |
/episodes |
Méthode |
GET |
filtres |
key1=val1&kay2=val2 |
Filtres de recherche¶
Les filtres de recherche doivent être envoyés dans l’url: episode?key1=val1&key2=val2
Le web-service accepte les filtres suivants:
Paramètre |
format |
O/F |
|---|---|---|
dtdebut |
datetime |
O |
dtfin |
datetime |
F |
cdmodeles |
string[] |
F |
cdsiteshydro |
string[] |
F |
Le web-service renvoie les épisodes dont la plage temporelle intersecte la plage [dtdebut-dtfin].
cdmodeles¶
Recherche de type contient.
Les codes modèles doivent contenir au moins deux caractères. Exemple: 31, PLA, GRP.
Avec le filtre cdmodeles=PLA,31, le web-service renvoie tous les épisodes associés à des codes modèles contenant PLA (modèles Plathynes) ou 31 .
dtdebut¶
La date fournie doit être au format yyyy-mm-ddThh:mm:ss.
Avec ce filtre, le web-service renvoie les épisodes dont la date de fin est postérieure à la date fournie.
dtfin¶
La date fournie doit être au format yyyy-mm-ddThh:mm:ss.
Avec ce filtre, le web-service renvoie les épisodes dont la date de début est antérieure à la date fournie.
cdsiteshydro¶
Recherche de type commence par.
Les codes des sites hydro doivent contenir au moins 4 caractères (code de la zone hydro).
Retour¶
Le web-service renvoie un tableau d’objets épisodes au format JSON.
Les épisodes sont retournés au format court. Seuls les codes, les libellés et les dates de début et de fin sont retournés.
Erreurs¶
erreurs d’authentification
absence du paramètre obligatoire dtdebut
présence de paramètres supplémentaires non autorisés
erreurs dans les formats de date