Modification d’un capteur¶

Ce web-service permet de modifier des capteurs en PHyC.

Paramètres HTTP¶

Paramètre	Valeur
Route	capteur
Méthode	PUT
Contenu	un capteur au format json

Droit de gestion¶

Il faut disposer du rôle ADM ou POLE2 ou POLE3 sur la station hydro pour modifier un capteur.

Contenu de la requête HTTP¶

La requête HTTP doit contenir un json hydrométrie contenant un capteur.

Json hydrométrie¶

Schéma de validation¶

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://phyc.org/ws/ajouterCapteurHydro.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"},
                    "Capteurs": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "CdCapteur": {"type":  "string"},
                          "LbCapteur": {"type": ["string", "null"]},
                          "MnCapteur": {"type": ["string", "null"]},
                          "TypCapteur": {"type": "integer"},
                          "ASurveillerCapteur": {"type":  "boolean"},
                          "PDTCapteur": {"type":  ["integer", "null"]},
                          "EssaiCapteur": {"type": "boolean"},
                          "ComCapteur": {"type": ["string", "null"]},
                          "Observateur":{
                            "type": ["object", "null"],
                            "properties": {
                              "CdContact": {"type": "string"}
                            },
                            "required": ["CdContact"],
                            "additionalProperties": false
                          },
                          "CdCapteurAncienRef": {"type": ["string", "null"]}
                        },
                        "required": ["CdCapteur"],
                        "additionalProperties": false
                      },
                      "minItems": 1
                    }
                  },
                  "required": ["CdStationHydro", "Capteurs"],
                  "additionalProperties": false
                }
              }
            },
            "required": ["CdSiteHydro", "StationsHydro"],
            "additionalProperties": false
          },
          "minItems": 1
        }
      },
      "required": ["SitesHydro"],
      "additionalProperties": false
    }
  },
  "required": ["Scenario", "RefHyd"],
  "additionalProperties": false
}

les attributs RefHyd et Scenario sont obligatoires;
RefHyd doit contenir un unique attribut SitesHydro qui contiendra un unique objet SiteHydro;
SiteHydro doit contenir les attributs CdSiteHydro et StationsHydro;
StationsHydro ne doit contenir qu’un seul objet StationHydro;
l’objet StationHydro doit contenir les deux propriétés CdStationHydro et Capteurs;
Capteurs doit être une liste ne contenant qu’une seule objet Capteur;
les attributs TypMesureCapteur et DtMajCapteur ne doivent pas être présents;

Règles techniques¶

Le site hydro, la station hydro et le capteur doivent être présente en PHyC.

La station doit bien être associé au site hydro. et le capteur doit être associé à la la station.

Il n’est pas possible de modifier la grandeur d’un capteur (absence de l’attribut TypMesureCapteur).

Le pas de temps d’un capteur si défini doit être strictement positif, inférieur ou égal à 60 et être un diviseur de 60.

Réponse du service¶

Le web-service renverra le json hydrométrie founi en entrée et ajoutera l’attribut DtMajCapteur.