Ajout d’un jaugeage¶
Ce web-service permet d’ajouter des jaugeages en PHyC.
Paramètres HTTP¶
Paramètre |
Valeur |
|---|---|
Route |
jaugeage |
Méthode |
POST |
Contenu |
un jaugeage au format json |
Droit de gestion¶
Pour ajouter 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¶
Les stations hydrométriques des hauteurs doivent dépendre du site hydro.
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", "const": 0},
"DebitJaugeage": {"type": "number"},
"DtDebJaugeage": {"type": "string", "format": "date-time"},
"DtFinJaugeage": {"type": "string", "format": "date-time"},
"SectionMouilJaugeage": {"type": "number"},
"PerimMouilleJaugeage": {"type": "number"},
"LargMiroirJaugeage": {"type": "number"},
"ModeJaugeage": {"type": "integer"},
"ComJaugeage": {"type": "string"},
"VitesseMoyJaugeage": {"type": "number"},
"VitesseMaxJaugeage": {"type": "number"},
"VitesseMaxSurfaceJaugeage": {"type": "number"},
"CdSiteHydro": {"type": "string"},
"HauteursJaugeage": {
"type": "array",
"items": {
"type": "object",
"properties": {
"CdStationHydro": {"type": "string"},
"SysAltiStationJaugeage": {"type": "integer"},
"CoteRetenueStationJaugeage": {"type": "number"},
"CoteDebutStationJaugeage": {"type": "number"},
"CoteFinStationJaugeage": {"type": "number"},
"DnStationJaugeage": {"type": "number"},
"DistanceStationJaugeage": {"type": "integer"},
"StationFille": {
"type": "object",
"properties": {
"CdStationHydro": {"type": "string"}
},
"required": ["CdStationHydro"],
"additionalProperties": false
}
},
"required": ["CdStationHydro", "SysAltiStationJaugeage",
"CoteRetenueStationJaugeage"],
"additionalProperties": false
},
"minItems": 1
},
"NumJaugeage": {"type": "string"},
"IncertCalJaugeage": {"type": "number"},
"IncertRetenueJaugeage": {"type": "number"},
"QualifJaugeage": {"type": "integer"},
"ComPrivJaugeage": {"type": "string"},
"CourbesTarage": {
"type": "array",
"items": {
"type": "object",
"properties": {
"CdCourbeTarage": {"type": "string"}
},
"required": ["CdCourbeTarage"],
"additionalProperties": false
},
"minItems": 1
}
},
"required": ["CdJaugeage", "DebitJaugeage", "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’objet Jaugeage;
Les attributs CdJaugeage, DebitJaugeage, CdSiteHydro et DtDebJaugeage de l’objet Jaugeage sont obligatoires;
L’attribut CdJaugeage doit obligatoirement valoir 0;
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 renseignera le code de jaugeage (attribut CdJaugeage).
Le web-service rajoutera l’attribut DtMajJaugeage au jaugeage.