Publication de règle de sites virtuels (**déprécié**)
=====================================================

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

Paramètres HTTP
---------------

========= ================
Paramètre Valeur
========= ================
Route     reglesitevirtuel
Méthode   GET
========= ================

Paramètres URL
--------------

========== ========================= ========= ===
Nom        Description               Type      O/F
========== ========================= ========= ===
cdsites    liste de codes de sites   list(str) O
dtmaj      date de mise à jour       datetime  F
========== ========================= ========= ===

Droit de publication
^^^^^^^^^^^^^^^^^^^^

Les droits de publication sont liés aux sites hydro passés en paramètres.

Il n'est pas nécessaire d'être authentifier pour publier un site public.

L'authentification est obligatoire pour les autres sites hydro.

Dans le cas d'un site restreint (droit de publication = 20), l'utilisateur doit avoir le profil
institutionnel ou posséder un rôle sur le site hydro.

Et dans le cas d'un site privé (droit de publication = 30), l'utilisateur doit posséder un rôle sur
le site hydro.

Réponse du web-service
----------------------

Le web-service renvoie un json hydrométrie contenant les périodes d'activités des sites virtuels.

Le json hydrométrie contient les deux propriétés Scenario et RefHyd.

RefHyd
^^^^^^

L'objet RefHyd contiendra l'unique propriété SitesHydro.

SitesHydro est une liste d'objets SiteHydro non vide.

SiteHydro
^^^^^^^^^

Propriétés de l'objet SiteHydro:

- CdSiteHydro
- LbSiteHydro
- TypSiteHydro
- PeriodesActiviteSiteHydroVirtuel : liste non vide d'objets PeriodeActiviteSiteHydroVirtuel

PeriodeActiviteSiteHydroVirtuel
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Propriétés de l'objet PeriodeActiviteSiteHydroVirtuel:

- DtDebActivationPeriodeActiviteSiteHydroVirtuel
- DtFinActivationPeriodeActiviteSiteHydroVirtuel
- DtDebPeriodeActiviteSiteHydroVirtuel
- DtFinPeriodeActiviteSiteHydroVirtuel
- SitesHydroAttaches SiteHydroAttache

SiteHydroAttache
^^^^^^^^^^^^^^^^

Propriétés de l'objet SiteHydroAttache:

- SiteHydro : objet SiteHydroSimple
- PonderationSiteHydroAttache
- DecalSiteHydroAttache

SiteHydroSimple
^^^^^^^^^^^^^^^

Propriété de l'objet SiteHydroSimple:

- CdSiteHydro
- LbSiteHydro


Exemple
^^^^^^^

.. code-block:: json
   :caption: Sites hydro au format json

   {
     "Scenario": {},
     "RefHyd": {
       "SitesHydro": [
         {
            "CdSiteHydro": "A1234567",
            "PeriodesActiviteSiteHydroVirtuel": [
              {
                "DtDebActivationPeriodeActiviteSiteHydroVirtuel": "2014-01-01T00:00:00",
                "DtDebPeriodeActiviteSiteHydroVirtuel": "2005-01-01T00:00:00",
                "DtFinPeriodeActiviteSiteHydroVirtuel": "2020-01-01T00:00:00",
                "SitesHydroAttaches": [
                  {
                    "SiteHydro": {
                      "CdSiteHydro": "B1234567",
                      "LbSiteHydro": "Lb fils"
                    },
                    "PonderationSiteHydroAttache": 0.5,
                    "DecalSiteHydroAttache": 5
                  }
                ]
              }
            ]
         }
       ]
     }
   }
