Modification d’un jaugeage¶
Ce web-service permet de modifier des jaugeages en PHyC.
Paramètres HTTP¶
Paramètre |
Valeur |
|---|---|
Route |
jaugeage |
Méthode |
PUT |
Contenu |
un jaugeage au format json |
Droit de gestion¶
Pour modifier un jaugeage, il faut avoir:
soit le rôle ADM ou POLE2 sur le site hydro de jaugeage
ou le rôle JAU sur la zone hydro du site de jaugeage
Règles techniques¶
Le jaugeage doit exister.
Les stations hydrométriques des hauteurs doivent dépendre du site hydro.
Hauteurs de jaugeage¶
Le web-services permet d’ajouter ou de modifier des hauteurs de jaugeage sur les stations du site hydrométrique.
Contenu de la requête HTTP¶
La requête HTTP doit contenir un json hydrométrie contenant un jaugeage.
Json hydrométrie¶
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://phyc.org/ws/ajouterJaugeageHydro.json",
"type": "object",
"properties": {
"Scenario": {
"type": "object"
},
"Donnees": {
"type": "object",
"properties": {
"Jaugeages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"CdJaugeage": {"type": "integer"},
"DebitJaugeage": {"type": "number"},
"DtDebJaugeage": {"type": "string", "format": "date-time"},
"DtFinJaugeage": {"type": ["string", "null"], "format": "date-time"},
"SectionMouilJaugeage": {"type": ["number", "null"]},
"PerimMouilleJaugeage": {"type": ["number", "null"]},
"LargMiroirJaugeage": {"type": ["number", "null"]},
"ModeJaugeage": {"type": "integer"},
"ComJaugeage": {"type": ["string", "null"]},
"VitesseMoyJaugeage": {"type": ["number", "null"]},
"VitesseMaxJaugeage": {"type": ["number", "null"]},
"VitesseMaxSurfaceJaugeage": {"type": ["number", "null"]},
"CdSiteHydro": {"type": "string"},
"HauteursJaugeage": {
"type": "array",
"items": {
"type": "object",
"properties": {
"CdStationHydro": {"type": "string"},
"SysAltiStationJaugeage": {"type": "integer"},
"CoteRetenueStationJaugeage": {"type": "number"},
"CoteDebutStationJaugeage": {"type": ["number", "null"]},
"CoteFinStationJaugeage": {"type": ["number", "null"]},
"DnStationJaugeage": {"type": ["number", "null"]},
"DistanceStationJaugeage": {"type": ["integer", "null"]},
"StationFille": {
"type": ["object", "null"],
"properties": {
"CdStationHydro": {"type": "string"}
},
"required": ["CdStationHydro"],
"additionalProperties": false
}
},
"required": ["CdStationHydro", "SysAltiStationJaugeage",
"CoteRetenueStationJaugeage"],
"additionalProperties": false
},
"minItems": 1
},
"NumJaugeage": {"type": "string"},
"IncertCalJaugeage": {"type": ["number", "null"]},
"IncertRetenueJaugeage": {"type": ["number", "null"]},
"QualifJaugeage": {"type": "integer"},
"ComPrivJaugeage": {"type": ["string", "null"]},
"CourbesTarage": {
"type": ["array", "null"],
"items": {
"type": "object",
"properties": {
"CdCourbeTarage": {"type": "string"}
},
"required": ["CdCourbeTarage"],
"additionalProperties": false
},
"minItems": 1
}
},
"required": ["CdJaugeage", "CdSiteHydro", "DtDebJaugeage"],
"additionalProperties": false
},
"minItems": 1
}
},
"required": ["Jaugeages"],
"additionalProperties": false
}
},
"required": ["Scenario", "Donnees"],
"additionalProperties": false
}
Les attributs Donnees (associé à l’objet Donnees) et Scenario sont obligatoires;
L’objet Donnees ne doit contenir qu’un seul attribut Jaugeages associé à une liste non vide d’objets Jaugeage;
Les attributs CdJaugeage, CdSiteHydro et DtDebJaugeage de l’objet Jaugeage sont obligatoires;
L’attribut HauteursJaugeage si fourni doit être une liste non vide d’objets HauteurJaugeage;
Les attributs CdStation, SysAltiStationJaugeage et CoteRetenueStationJaugeage de l’objet HauteurJaugeage sont obligatoires;
l’attribut DtMajJaugeage de la courbe de tarage ne doit pas être présent.
Réponse du web-service¶
En cas de succès, le web-service retournera un json hydrométrie contenant le jaugeage ajoutée.
Le web-service rajoutera l’attribut DtMajJaugeage au jaugeage.