Publication de seuils hydro
===========================

Les seuils sont associés à des sites hydro et les valeurs peuvent êtres associées soit à un site
hydro, une station hydro ou un capteur hydro.


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

========= ===============
Paramètre Valeur
========= ===============
Route     seuilshydro
Méthode   POST
========= ===============

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

Les paramètres doivent être transmis dans le contenu de la requête au format format JSON.

========= ====================== ========= ===
Nom       Description            Type      O/F
========= ====================== ========= ===
cdentites Codes des entités      list(str) O
dtdebut   Date de début          datetime  F
dtfin     Date de fin            datetime  F
dtmaj     Date de mise à jour    datetime  F
cdseuils  Codes des seuils       list(int) F
========= ====================== ========= ===

cdentites
^^^^^^^^^

Sites hydro
"""""""""""

Lorsque que l’on publie des seuils au niveau de sites, la PHyC retourne désormais les seuils
associés aux sites ainsi que l’ensemble des valeurs associées aux entités (sites, stations et
capteurs) pour lesquelles l’utilisateur dispose des bons droits de publication.

Stations hydro et capteurs
""""""""""""""""""""""""""

Pour les codes de stations hydro et capteurs, le web-service retourne les
valeurs des seuils de ces entités.

Droit de publication
--------------------

Les droits de publication dépendent des droits de publication des entités du caractère public du
seuil.

Droit de publications des entités
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Sites et/ou stations publics
""""""""""""""""""""""""""""
Il n'est pas nécessaire d'être authentifié pour afficher des seuils publiques.

Sites et / ou stations restreints
"""""""""""""""""""""""""""""""""

IL faut être institutionnel ou posséder un rôle sur l'entité pour publier des seuils publics sur ces
entités.

Sites et/ou stations privés
"""""""""""""""""""""""""""

L'utilisateur doit posséder un rôle sur l'entité pour publier des seuils publics.

Seuils non publics
^^^^^^^^^^^^^^^^^^

Les seuils non publics sont uniquement visibles par les utilisateurs ayant un rôle différent de VISU
sur les entités ou étant administrateurs nationaux.


Seuils spécifiques
^^^^^^^^^^^^^^^^^^

Les seuils de nature 23, 24, 101 et 102 ne sont publiés qu'aux contacts ayant des droits sur
l'entité et aux administrateurs nationaux.

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

Le web-service renvoie un json hydrométrie contenant des seuils hydro à publier.

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

RefHyd
^^^^^^

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

SeuilsHydro est une liste d'objets SeuilHydro non vide.

SeuilHydro
^^^^^^^^^^

L'objet SeuilHydro contiendra les propriétés suivantes:

- CdSeuilHydro
- SiteHydro : objet SiteHydro
- TypSeuilHydro
- NatureSeuilHydro
- DureeSeuilHydro
- LbUsuelSeuilHydro
- MnSeuilHydro
- TypPubliSeuilHydro
- IndiceGraviteSeuilHydro
- ValForceeSeuilHydro
- DtMajSeuilHydro
- ComSeuilHydro
- ValsSeuilHydro : liste non vide d'objets ValSeuilHydro

ValSeuilHydro
^^^^^^^^^^^^^
Propriétés de l'objet ValSeuilHydro:

- ValValSeuilHydro
- ToleranceValSeuilHydro
- DtActivationValSeuilHydro
- DtDesactivationValSeuilHydro
- SiteHydro ou StationHydro ou Capteur : un objet SiteHdyro ou StationHydro ou Capteur

SiteHydro
^^^^^^^^^
Propriétés de l'objet SiteHydro:

- CdSiteHydro
- LbSiteHydro

StationHydro
^^^^^^^^^^^^

Propriétés de l'objet StationHydro:

- CdStationHydro
- LbStationHydro

Capteur
^^^^^^^

Propriétés de l'objet Capteur:
- CdCapteur
- LbCapteur

Exemple (crue de la Seine de 1910)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

   {
     "Scenario": {},
     "RefHyd": {
       "SeuilsHydro": [
         {
           "CdSeuilHydro": 2297,
           "SiteHydro": {
             "CdSiteHydro": "F7000001"
           },
           "TypSeuilHydro":1,
           "NatureSeuilHydro": 32,
           "LbUsuelSeuilHydro": "Crue du 28\/01\/1910",
           "MnSeuilHydro": "Autre",
           "TypPubliSeuilHydro": 10,
           "IndiceGraviteSeuilHydro": 90,
           "ValForceeSeuilHydro": true,
           "DtMajSeuilHydro": "2020-10-21T14:20:35",
           "ValsSeuilHydro": [
             {
               "ValValSeuilHydro":8620,
               "ToleranceValSeuilHydro":0,
               "DtActivationValSeuilHydro":"2014-11-27T19:04:49",
               "StationHydro": {
                 "CdStationHydro":"F700000103"
               }
             }
           ]
         }
       ]
     }
   }
