Modification d’une station hydro

Ce web-service permet de modifier des stations hydro en PHyC.

Paramètres HTTP

Paramètre

Valeur

Route

stationhydro

Méthode

PUT

Contenu

une station hydro au format json

Droit de gestion

IL faut posséder le rôle ADM ou POLE2 ou POLE3 sur la station hydro pour pouvoir la modifier.

Règles techniques

Le site hydro et la station hydro doivent exister.

La station hydro doit bien être associée au site hydro.

Il n’est pas possible de modifier le type d’une station.

La commune de la station à modifier doit correspondre à une des communes du site parent.

Le libellé de la station est généré par le web-service.

Contenu de la requête HTTP

La requête HTTP doit contenir un json hydrométrie contenant une station hydro.

Json hydrométrie

Schéma de validation
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://phyc.org/ws/ajouterStationHydro.json",
  "type": "object",
  "properties": {
    "Scenario": {
      "type": "object"
    },
    "RefHyd": {
      "type": "object",
      "properties": {
        "SitesHydro": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "CdSiteHydro": {"type": "string"},
              "StationsHydro": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "CdStationHydro": {
                      "type": "string"
                    },
                    "ComplementLbStationHydro": {
                      "type": ["string", "null"]
                    },
                    "ComPrivStationHydro": {
                      "type": ["string", "null"]
                    },
                    "CoordStationHydro": {
                      "type": "object",
                      "properties": {
                        "CoordXStationHydro": {
                          "type": "number"
                        },
                        "CoordYStationHydro": {
                          "type": "number"
                        },
                        "ProjCoordStationHydro": {
                          "type": "integer"
                        }
                      },
                      "required": [
                        "CoordXStationHydro",
                        "CoordYStationHydro",
                        "ProjCoordStationHydro"
                      ],
                      "additionalProperties": false
                    },
                    "PkStationHydro": {
                      "type": ["number", "null"]
                    },
                    "DtMiseServiceStationHydro": {
                      "type": ["string", "null"], "format": "date-time"
                    },
                    "DtFermetureStationHydro": {
                      "type": ["string", "null"], "format": "date-time"
                    },
                    "ASurveillerStationHydro": {
                      "type": "boolean"
                    },
                    "NiveauAffichageStationHydro": {
                      "type": ["integer", "null"]
                    },
                    "DroitPublicationStationHydro": {
                      "type": "integer"
                    },
                    "DelaiDiscontinuiteStationHydro": {
                      "type": ["integer", "null"]
                    },
                    "DelaiAbsenceStationHydro": {
                      "type": ["integer", "null"]
                    },
                    "EssaiStationHydro": {
                      "type": "boolean"
                    },
                    "InfluLocaleStationHydro": {
                      "type": "integer"
                    },
                    "ComInfluLocaleStationHydro": {
                      "type": ["string", "null"]
                    },
                    "ComStationHydro": {
                      "type": ["string", "null"]
                    },
                    "StationsHydroAnterieures": {
                      "type": ["array", "null"],
                      "items": {
                        "type": "object",
                        "properties": {
                          "CdStationHydro": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "CdStationHydro"
                        ],
                        "additionalProperties": false
                      },
                      "minItems": 1
                    },
                    "StationsHydroPosterieures": {
                      "type": ["array", "null"],
                      "items": {
                        "type": "object",
                        "properties": {
                          "CdStationHydro": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "CdStationHydro"
                        ],
                        "additionalProperties": false
                      },
                      "minItems": 1
                    },
                    "QualifsDonneesStationHydro": {
                      "type": ["array", "null"],
                      "items": {
                        "type": "object",
                        "properties": {
                          "CdRegime": {
                            "type": "integer"
                          },
                          "QualifDonStationHydro": {
                            "type": "integer"
                          },
                          "ComQualifDonStationHydro": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "CdRegime",
                          "QualifDonStationHydro"
                        ],
                        "additionalProperties": false
                      },
                      "minItems": 1
                    },
                    "FinalitesStationHydro": {
                      "type": ["array", "null"],
                      "items": {
                        "type": "object",
                        "properties": {
                          "CdFinaliteStationHydro": {
                            "type": "integer"
                          }
                        },
                        "required": [
                          "CdFinaliteStationHydro"
                        ],
                        "additionalProperties": false
                      },
                      "minItems": 1
                    },
                    "LoisStatContexteStationHydro": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "TypContexteLoiStat": {
                            "type": "integer"
                          },
                          "TypLoiStationHydro": {
                            "type": "integer"
                          }
                        },
                        "required": [
                          "TypContexteLoiStat",
                          "TypLoiStationHydro"
                        ],
                        "additionalProperties": false
                      },
                      "minItems": 1
                    },
                    "ImagesStationHydro": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "AdressedelImageStationHydro": {
                            "type": "string"
                          },
                          "TypIllStationHydro": {
                            "type": "integer"
                          },
                          "ComImgStationHydro": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "AdressedelImageStationHydro"
                        ],
                        "additionalProperties": false
                      },
                      "minItems": 1
                    },
                    "ReseauxMesureStationHydro": {
                      "type": ["array", "null"],
                      "items": {
                        "type": "object",
                        "properties": {
                          "CodeSandreRdd": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "CodeSandreRdd"
                        ],
                        "additionalProperties": false
                      },
                      "minItems": 1
                    },
                    "RefsAlti": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "AltitudeRefAlti": {
                            "type": "number"
                          },
                          "SysAltiRefAlti": {
                            "type": "integer"
                          },
                          "DtDebutRefAlti": {
                            "type": "string", "format": "date-time"
                          },
                          "DtFinRefAlti": {
                            "type": "string", "format": "date-time"
                          }
                        },
                        "required": [
                          "AltitudeRefAlti",
                          "SysAltiRefAlti",
                          "DtDebutRefAlti"
                        ],
                        "additionalProperties": false
                      },
                      "minItems": 1
                    },
                    "CdStationHydroAncienRef": {
                      "type": ["string", "null"]
                    },
                    "Commune": {
                      "type": "object",
                      "properties": {
                        "CdCommune": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "CdCommune"
                      ],
                      "additionalProperties": false
                    },
                    "StationsHydroAmont": {
                      "type": ["array", "null"],
                      "items": {
                        "type": "object",
                        "properties": {
                          "CdStationHydro": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "CdStationHydro"
                        ],
                        "additionalProperties": false
                      },
                      "minItems": 1
                    },
                    "StationsHydroAval": {
                      "type": ["array", "null"],
                      "items": {
                        "type": "object",
                        "properties": {
                          "CdStationHydro": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "CdStationHydro"
                        ],
                        "additionalProperties": false
                      },
                      "minItems": 1
                    }
                  },
                  "required": ["CdStationHydro"],
                  "additionalProperties": false
                },
                "minItems": 1
              }
            },
            "required": ["CdSiteHydro", "StationsHydro"],
            "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 les attributs CdSiteHydro et StationsHydro;

  • StationHydro doit être une liste contenant un unique objet StationHydro;

  • L’objet StationHydro doit contenir obligatoirement l’attribut CdStationHydro;

  • Les attributs LbStationHydro, TypStationHydro, DtMajStationHydro, Capteurs, RolsContactStationHydro  ne doivent pas être présents pour l’objet StationHydro;,

  • les attributs DtActivationRefAlti, DtDesactivationRefAlti ne doivent pas être présents pour l’objet RefAlti.

Réponse du service

Le web-service renverra le json hydrométrie contenant la station modifiée.

Le web-service rajoutera les attributs à la station:

  • LbStationHydro: Le libellé de la station est regénéré automatiquement selon le format: « article+cours d’eau – [précision du cours d’eau] – article+commune – [complément du nom] – complément station »;

  • DtMajStationHydro : date de mise à jour de la station;

  • DtActivationRefAlti pour les objets RefAlti.