Ajout d’un seuil hydro¶
Ce web-service permet d’ajouter des seuils hydro en PHyC.
Paramètres HTTP¶
Paramètre |
Valeur |
|---|---|
Route |
seuilhydro |
Méthode |
POST |
Contenu |
un seuil hydro au format json |
Droit de gestion¶
Il faut posséder le rôle ADM OU POLE2 ou PREVI sur le site hydro associé au seuil.
Règles techniques¶
Pour les mnémoniques de seuil de vigilance, la PHyC générera une erreur si l’indice de gravité ne correspond au mnémonique associé. Se référer au tableau de la page: Gestion des seuils hydro et météo.
L’indice de gravité est facultatif. La PhyC fournira la bonne valeur pourr les seuils de vigilance.
Pour des seuils de vigilance, la PHYC impose les contraintes suivantes:
les seuils de vigilance sont de type absolu (1)
les seuils de vigilance ne sont pas publics (droit de publication >= 20)
les seuil de vigilance sont de nature “seuil technique valeur fort” (22)
Contenu de la requête HTTP¶
La requête HTTP doit contenir un json hydrométrie contenant un seuil hydro.
Json hydrométrie¶
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://phyc.org/ws/ajouterSeuilHydro.json",
"type": "object",
"properties": {
"Scenario": {
"type": "object"
},
"RefHyd": {
"type": "object",
"properties": {
"SeuilsHydro": {
"type": "array",
"items": {
"type": "object",
"properties": {
"CdSeuilHydro": {"type": "integer", "const": 0},
"SiteHydro": {
"type": "object",
"properties": {
"CdSiteHydro": {"type": "string"}
},
"required": ["CdSiteHydro"],
"additionalProperties": false
},
"TypSeuilHydro": {"type": "integer"},
"NatureSeuilHydro": {"type": "integer"},
"DureeSeuilHydro": {"type": "integer"},
"LbUsuelSeuilHydro": {"type": "string"},
"MnSeuilHydro": {"type": "string"},
"TypPubliSeuilHydro": {"type": "integer"},
"IndiceGraviteSeuilHydro": {"type": "integer"},
"ValForceeSeuilHydro": {"type": "boolean"},
"ComSeuilHydro": {"type": "string"},
"ValsSeuilHydro": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ValValSeuilHydro": {"type": "number"},
"ToleranceValSeuilHydro": {"type": "number"},
"StationHydro": {
"type": "object",
"properties": {
"CdStationHydro": {"type": "string"}
},
"required": ["CdStationHydro"],
"additionalProperties": false
},
"SiteHydro": {
"type": "object",
"properties": {
"CdSiteHydro": {"type": "string"}
},
"required": ["CdSiteHydro"],
"additionalProperties": false
},
"Capteur": {
"type": "object",
"properties": {
"CdCapteur": {"type": "string"}
},
"required": ["CdCapteur"],
"additionalProperties": false
}
},
"required": ["ValValSeuilHydro"],
"oneOf": [
{"required": ["StationHydro"]},
{"required": ["SiteHydro"]},
{"required": ["Capteur"]}
],
"additionalProperties": false
},
"minItems": 1
}
},
"required": ["CdSeuilHydro", "SiteHydro", "TypSeuilHydro", "NatureSeuilHydro"],
"additionalProperties": false
},
"minItems": 1
}
},
"required": ["SeuilsHydro"],
"additionalProperties": false
}
},
"required": ["Scenario", "RefHyd"],
"additionalProperties": false
}
Les attributs RefHyd (associé à l’objet Refhyd) et Scenario sont obligatoires;
L’objet RefHyd ne doit contenir qu’un seul attribut SeuilsHydro associé à une liste non vide d’objets SeuilHydro;
L’objet SeuilHydro doit contenir les attributs CdSeuilHydro, SiteHydro, TypSeuilHydro, NatureSeuilHydro;
L’attribut CdSeuilHydro doit obligatoirement prendre comme valeur 0;
L’objet SeuilHydro ne doit pas contenir l’attribut DtMajSeuilHydro.
ValsSeuilHydro doit être une liste non vide d’objets ValSeuilHydro;
ValSeuilHydro doit contenir une des propriété SiteHydro ou StationHydro ou Capteur;
La propriété ValValSeuilHydro de l’objet ValSeuilHydro est obligatoire;
ValSeuilHydro ne doit pas contenir les propriétés DtActivationValSeuilHydro et DtDesactivationValSeuilHydro
Réponse du web-service¶
En cas de succès, le web-service retournera un json hydrométrie contenant le seuil hydro ajouté.
Le web-service renseignera l’attribut CdSeuilHydro avec le code généré par la PHyC.
Le web-service rajoutera l” attribut DtMajSeuilHydro au seuil hydro.
Le web-service rajoutera l’attribut DtActivationValSeuilHydro pour l’objet ValSeuilHydro.