Gestion des règles des sites virtuels¶

Ce web-service permet de gérer les règles de calcul des débits des sites virtuels.

Paramètres HTTP¶

Paramètre	Valeur
Route	periodesitevirtuel
Méthode	POST ou PUT
Contenu	Période d’un site virtuel au format json

Droit de gestion¶

Il faut posséder le rôle ADM ou POLE2 sur le site virtuel.

Règles techniques¶

La pondération d’un site attaché peut être négatif ou positif. Il doit être compris entre -100 et 100.

Le décalage d’un site attaché est exprimé en minutes. Il peut être négatif ou positif.

Le décalage doit être négatif pour que les dates des observations du site virtuel soient ultérieures aux dates des observtationsdes sites fils.

Contenu de la requête HTTP¶

La requête HTTP doit contenir un json hydrométrie contenant des périodes d’activité d’un site virtuel.

Format JSON¶

Schéma de validation¶

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://phyc.org/ws/ajouterSeuilHydro.json",
  "type": "object",
  "properties": {
    "Scenario": {
      "type": "object"
    },
    "RefHyd": {
      "type": "object",
      "properties": {
        "SitesHydro": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "CdSiteHydro": {"type": "string"},
              "PeriodesActiviteSiteHydroVirtuel": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "DtDebPeriodeActiviteSiteHydroVirtuel": {"type": "string", "format": "date-time"},
                    "DtFinPeriodeActiviteSiteHydroVirtuel": {"type": "string", "format": "date-time"},
                    "SitesHydroAttaches": {
                      "type": "array",
                      "items":{
                        "type": "object",
                        "properties": {
                          "SiteHydro": {
                            "type": "object",
                            "properties": {
                              "CdSiteHydro": {"type": "string"}
                            },
                            "required": ["CdSiteHydro"],
                            "additionalProperties": false
                          },
                          "PonderationSiteHydroAttache": {"type": "number"},
                          "DecalSiteHydroAttache": {"type": "integer"}
                        },
                        "required": ["SiteHydro", "PonderationSiteHydroAttache"],
                        "additionalProperties": false
                      }
                    }
                  },
                  "required": ["SitesHydroAttaches"],
                  "additionalProperties": false
                },
                "minItems": 1
              }
            },
            "required": ["CdSiteHydro", "PeriodesActiviteSiteHydroVirtuel"],
            "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 obligatoirement les attributs CdSiteHydro et PeriodesActiviteSiteHydroVirtuel;
L’objet PeriodesActiviteSiteHydroVirtuel doit être une liste non vide d’objets PeriodeActiviteSiteHydroVirtuel
L’attribut SitesHydroAttaches de l’objet PeriodeActiviteSiteHydroVirtuel est obligatoire.
Les attributs DtDebPeriodeActiviteSiteHydroVirtuel et DtFinPeriodeActiviteSiteHydroVirtuel sont facultatifs:
SitesHydroAttaches doit être une liste non vide d’objets SiteHydroAttache;
L’objet SiteHydroAttache doit contenir obligatoirement un objet SiteHydro (contenant l’unique attribut CdSiteHydro) et l’attribut PonderationSiteHydroAttache;
L’attribut DecalSiteHydroAttache de l’objet SiteHydroAttache est facultatif;

Réponse du service¶

Le web-service renverra le json hydrométrie contenant les périodes d’activité du site virtuel.

Le web-service rajoutera l’attribut DtDebActivationPeriodeActiviteSiteHydroVirtuel aux objets PeriodeActiviteSiteHydroVirtuel.