Publication de plages d’utilisation¶

Ce web-service permet de publier les plages d’utilisation de stations et capteurs.

Paramètres HTTP¶

Paramètre	Valeur
Route	plagesutilisation
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	liste de codes de sites ou de stations	list(str)	O
dtdebut	date de début	datetime	F
dtfin	date de fin	datetime	F
dtactivation	date d’activation	datetime	F
dtmaj	date de mise à jour	datetime	F

Filtre cdentites¶

Pour un code de site, le web-service renverra les plages d’utilisation des stations du site.

Pour une code de station, il renverra les plages d’utilisation des capteurs de la station.

Droit de publication¶

Les droits de publication sont liés aux codes des entités passées en paramètre.

Site et station publics¶

Il n’est pas nécessaire d’être authentifié pour publier des plages d’utilisation d’entités publiques.

Site et station restreints¶

Pour les entités restreintes, il faut être authentifié et l’utilisateur doit avoir le profil institutionnel ou posséder un rôle sur l’entité.

Site et station privés¶

Pour les entités privées, il faut être authentifié et l’utilisateur doit posséder un rôle sur l’entité.

Réponse du service¶

Réponse du web-service¶

Le web-service renvoie un json hydrometrie contenant les plages d’utilisation à publier.

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

RefHyd¶

L’objet RefHyd contiendra une unique propriété SitesHydro

SitesHydro est une liste non vide d’objets SiteHydro.

SiteHydro¶

Propriétés de l’objet SiteHydro:

CdSiteHydro
StationsHydro: liste d’objet non vide StationHydro

StationHydro¶

Propriétés de l’objet StationHydro:

CdStationHydro
PlagesUtilStationHydro liste non vide d’objets PlageUtilStationHydro
Capteurs : liste non vide d’objets Capteur

PlageUtilStationHydro¶

Propriétés de l’objet PlageUtilStationHydro:

DtDebPlageUtilStationHydro
DtFinPlageUtilStationHydro
DtActivationPlageUtilStationHydro
DtDesactivationPlageUtilStationHydro
ActivePlageUtilStationHydro

Capteur¶

Propriétés de l’objet Capteur:

CdCapteur
PlagesUtilCapteur : liste non vide d’objets PlageUtilCapteur

PlageUtilCapteur¶

Propriétés de l’objet PlageUtilCapteur:

DtDebPlageUtilCapteur
DtFinPlageUtilCapteur
DtActivationPlageUtilCapteur
DtDesactivationPlageUtilCapteur
ActivePlageUtilCapteur

Exemple¶

Capteurs au format json¶

{
  "Scenario": {},
  "RefHyd": {
    "SitesHydro": [
      {
         "CdSiteHydro": "A1234567",
         "StationsHydro": [
           {
             "CdStationHydro": "A123456789",
             "Capteurs": [
               {
                 "CdCapteur": "A12345678901",
                 "PlagesUtilCapteur": [
                   {
                     "DtDebPlageUtilCapteur": "2014-01-01T00:00:00",
                     "DtFinPlageUtilCapteur": "2018-01-01T00:00:00",
                     "DtActivationPlageUtilCapteur": "2015-01-01T00:00:00",
                     "DtDesactivationPlageUtilCapteur": "2022-01-01T00:00:00",
                     "ActivePlageUtilCapteur": true
                   }
                 ],
               }
             ]
           }
         ]
      }
    ]
  }
}