Modification d’un site hydro¶
Ce web-service permet de modifier des sites hydro en PHyC.
Paramètres HTTP¶
Paramètre |
Valeur |
|---|---|
Route |
sitehydro |
Méthode |
PUT |
Contenu |
un site hydro au format json |
Droit de gestion¶
L’utilisateur doit posséder le rôle ADM ou POLE2 sur le site pour pouvoir le modifier.
Règles techniques¶
Le site hydro doit exister.
On ne peut pas modifier le type du site.
L’attribut facultatif CdBNBV ne peut être renseigné qu par les utilisateurs ayant le profil institutionnel.
Les images, les tronçons vigilance et les lames d’eau associés au site hydro fourni en paramètre remplacent les objets actuellement asosociés.
La valeur de la pondération (PonderationPluieDeBassin) doit être un flottant compris entre 0 et 100.
Contenu de la requête HTTP¶
La requête HTTP doit contenir un json hydrométrie contenant un site hydro.
Format JSON¶
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://phyc.org/ws/ajouterContactSiteHydro.json",
"type": "object",
"properties": {
"Scenario": {
"type": "object"
},
"RefHyd": {
"type": "object",
"properties": {
"SitesHydro": {
"type": "array",
"items": {
"type": "object",
"properties": {
"CdSiteHydro": {"type": "string"},
"LbUsuelSiteHydro": {"type": ["string", "null"]},
"TypSiteHydro": {"type": "string"},
"PrecisionTypSiteHydro": {"type": "integer"},
"MnSiteHydro": {"type": ["string", "null"]},
"ComplementLbSiteHydro": {"type": ["string", "null"]},
"CoordSiteHydro": {
"type": "object",
"properties": {
"CoordXSiteHydro": {"type": "number"},
"CoordYSiteHydro": {"type": "number"},
"ProjCoordSiteHydro": {"type": "integer"}
},
"required": ["CoordXSiteHydro", "CoordYSiteHydro", "ProjCoordSiteHydro"],
"additionalProperties": false
},
"PkAmontSiteHydro": {"type": ["number", "null"]},
"PkAvalSiteHydro": {"type": ["number", "null"]},
"AltiSiteHydro": {
"type": "object",
"properties": {
"AltitudeSiteHydro": {"type": "number"},
"SysAltimetriqueSiteHydro": {"type": "integer"}
},
"required": ["AltitudeSiteHydro", "SysAltimetriqueSiteHydro"],
"additionalProperties": false
},
"BassinVersantSiteHydro": {"type": ["number", "null"]},
"BassinVersantHydroSiteHydro": {"type": ["number", "null"]},
"FuseauHoraireSiteHydro": {"type": ["integer", "null"]},
"StSiteHydro": {"type": "integer"},
"DtPremDonSiteHydro": {"type": ["string", "null"], "format": "date-time"},
"PremMoisEtiageSiteHydro": {"type": ["integer", "null"]},
"PremMoisAnHydSiteHydro": {"type": ["integer", "null"]},
"DureeCarCruSiteHydro": {"type": ["integer", "null"]},
"DroitPublicationSiteHydro": {"type": "integer"},
"EssaiSiteHydro": {"type": "boolean"},
"InfluGeneSiteHydro": {"type": ["integer", "null"]},
"ComInfluGeneSiteHydro": {"type": ["string", "null"]},
"ComSiteHydro": {"type": ["string", "null"]},
"CdEuMasseDEau": {"type": "string"},
"EntiteHydrographique": {
"type": "object",
"properties": {
"CdEntiteHydrographique": {"type": "string"}
},
"required": ["CdEntiteHydrographique"],
"additionalProperties": false
},
"LoisStatContexteSiteHydro": {
"type": "array",
"items": {
"type": "object",
"properties": {
"TypContexteLoiStat": {"type": "integer"},
"TypLoiSiteHydro": {"type": "integer"}
},
"required": ["TypContexteLoiStat", "TypLoiSiteHydro"],
"additionalProperties": false
},
"minItems": 1
},
"ImagesSiteHydro": {
"type": "array",
"items": {
"type": "object",
"properties": {
"AdressedelImageSiteHydro": {"type": "string"},
"TypIllSiteHydro": {"type": "integer"},
"ComImgSiteHydro": {"type": "string"}
},
"required": ["AdressedelImageSiteHydro"],
"additionalProperties": false
},
"minItems": 1
},
"CdTronconHydrographique": {"type": "string"},
"EntsVigiCru": {
"type": ["array", "null"],
"items": {
"type": "object",
"properties": {
"CdEntVigiCru": {"type": "string"}
},
"required": ["CdEntVigiCru"],
"additionalProperties": false
},
"minItems": 1
},
"Communes":{
"type": "array",
"items": {
"type": "object",
"properties": {
"CdCommune": {"type": "string"}
},
"required": ["CdCommune"],
"additionalProperties": false
},
"minItems": 1
},
"CdSiteHydroAncienRef": {"type": "string"},
"PluiesDeBassin": {
"type": ["array", "null"],
"items": {
"type": "object",
"properties": {
"CdSiteMeteo": {"type": "string"},
"PonderationPluieDeBassin": {"type": "number"}
},
"required": ["CdSiteMeteo", "PonderationPluieDeBassin"],
"additionalProperties": false
},
"minItems": 1
},
"PrecisionCoursDEauSiteHydro": {"type": ["string", "null"]},
"SitesHydroAmont": {
"type": ["array", "null"],
"items": {
"type": "object",
"properties": {"CdSiteHydro": {"type": "string"}},
"required": ["CdSiteHydro"],
"additionalProperties": false
},
"minItems": 1
},
"SitesHydroAval": {
"type": ["array", "null"],
"items": {
"type": "object",
"properties": {"CdSiteHydro": {"type": "string"}},
"required": ["CdSiteHydro"],
"additionalProperties": false
},
"minItems": 1
},
"BNBV": {
"type": "object",
"properties": {"CdBNBV": {"type": "string"}},
"required": ["CdBNBV"],
"additionalProperties": false
}
},
"required": ["CdSiteHydro"],
"additionalProperties": false
},
"minItems": 1
}
},
"required": ["SitesHydro"],
"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 SitesHyddro associé à une liste ne contenant qu’un seul objet SiteHydro;
L’objet SiteHydro doit contenir obligatoirement l’attribut CdSiteHydro.
Les attributs TypSiteHydro, RolesContactSiteHydro, SiteHydroAssocie, PeriodesActiviteSiteHydroVirtuel, StationsHydro, ZoneHydro, LbSiteHydro et DtMajSiteHydro ne doivent être présents pour l’objet SiteHydro.
Réponse du service¶
Le web-service renverra le json hydrométrie contenant le site hydro ajoutée.
Le web-service rajoutera les attributs suivants au site:
LbSiteHydro: libellé généré automatiquement par la PHyC;
DtMajSiteHydro : date de mise à jour du site;