Gestion des plages d’utilisation d’une station¶

Ce web-service permet de gérer les plages d’utilisation d’une station hydro

Paramètres HTTP¶

Paramètre	Valeur
Route	plagestation
Méthode	POST ou PUT
Contenu	une plage d’utilisation d’une station au format json

Droit de gestion¶

L’utilisateur doit posséder le rôle ADM ou POLE2 ou PREVI sur le site de la station.

Règles techniques¶

Le site et la station hydro doivent exister.

La station hydro doit dépendre du site hydro.

La date de début doit être inférieure à la date de fin d’utilisation.

La station hydrologique ne doit pas être une station de type H ou HC.

Attribut ActivePlageUtilStationHydro¶

Si cet attribut est à true, cette plage va être insérée en PHyC.

Comme 2 stations ne peuvent être actives en même temps, la PHYC va désactiver les plages des autres stations du site intersectant la nouvelle plage d’utilisation.

Si cet attribut est à false, la plage va être désactiver. Les observations de la station sur cette plage ne remonteront plus au site.

Contenu de la requête HTTP¶

La requête HTTP doit contenir un json hydrométrie contenant la plage d’utilisation de la station hydro.

Format JSON¶

Schéma de validation¶

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://phyc.org/ws/gererPlageUtilisationCapteur.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"},
                          "PlagesUtilCapteur": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "DtDebPlageUtilCapteur": {"type":  "string", "format": "date-time"},
                                "DtFinPlageUtilCapteur": {"type":  "string", "format": "date-time"},
                                "ActivePlageUtilCapteur": {"type":  "boolean"}
                              },
                              "required": ["DtDebPlageUtilCapteur", "ActivePlageUtilCapteur"],
                              "additionalProperties": false
                            },
                            "minItems": 1
                          },
                          "CdCapteurAncienRef": {"type":  "string"}
                        },
                        "required": ["CdCapteur", "PlagesUtilCapteur"],
                        "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 (associé à l’objet Refhyd) et Scenario sont obligatoires;
L’objet RefHyd ne doit contenir qu’un seul attribut SitesHydro associé à une liste non vide d’objets SiteHydro;
L’objet SiteHydro doit contenir uniquement les attributs CdSiteHydro et StationsHydro;
StationsHydro doit être une liste non vide d’objets StationHydro;
StationHydro doit contenir uniquement les attributs CdStationHydro et PlagesUtilStationHydro
PlagesUtilStationHydro doit être une liste non vide d’objets PlageUtilStationHydro
PlageUtilStationHydro doit contenir obligatoirement les attributs DtDebPlageUtilStationHydro et ActivePlageUtilStationHydro
PlageUtilCapteur peut contenir l’attribut DtFinPlageUtilStationHydro.

Réponse du service¶

Le web-service renverra le json hydrométrie contenant la plage d’utilisation de la station.

En fonction de la valeur ActivePlageUtilStationHydro, le web-service rajoutera les attributs DtActivationPlageUtilStationHydro et DtDesactivationPlageUtilStationHydro.