Recherche de modèles¶
Description¶
Ce web-service permet de rechercher des modèles.
Paramètres HTTP¶
Paramètre |
Valeur |
|---|---|
Route |
modele |
Méthode |
GET |
filtres |
key1=val1&kay2=val2 |
Filtres de recherche¶
Les filtres de recherche doivent être envoyés dans l’url: event?key1=val1&key2=val2
Le web-service accepte les filtres suivants:
Paramètre |
format |
O/F |
|---|---|---|
cdmodeles |
string[] |
F |
dtmaj |
datetime |
F |
cdsiteshydro |
string[] |
F |
format |
int |
F |
cdmodeles¶
Recherche de type contient. La recherche par code modèle doit contenir au moins deux caractères. Exemple: 31, PLA, GRP.
Avec le filtre cdmodeles=PLA,31, le web-service renvoie les modèles dont le code contient PLA (modèles Plathynes) ou 31.
dtmaj¶
Ce filtre permet de récupérer les modèles mis à jour depuis la date fournie.
cdsiteshydro¶
Ce filtre est une liste de codes de site hydro.
Le web-service renverra une erreur si un des sites hydro n’existe pas.
Retour¶
Le paramètre peut prendre uniquement les valeurs 0, 1 ou 2.
Valeur |
Commentaire |
|---|---|
0 |
Retour court (code modèle, libellé et type) |
1 |
Retour long (ensemble des propriétés de l’objet Modele et les sites associés de sortie) |
2 |
Retour long avec les scenarios et les ressources associés au modèle. |
Par défaut, le retour du web-service est court.
Retour du web-service¶
Le web-service renvoie un tableau d’objets Modele au format JSON.
Avec retour = 2, le web-service retournera les objets Scenario (ainsi que les ressources) associés au modèle.
Erreurs¶
erreur d’authentification
code modèle vide
le code doit contenir au moins deux caractères
Codes de site hydro inexistants
erreur de format pour la date dtmaj