Publication de sites hydro¶

Paramètres HTTP¶

Paramètre	Valeur
Route	siteshydro
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
cdsites	liste de codes de sites	list(str)	F
dtmaj	date de mise à jour	datetime	F
stations	publication des stations	bool	F
capteurs	publication des capteurs	bool	F
roles	publication des rôles	bool	F

Si le paramètre cdsites n’est pas défini, le web-service retourne l’ensemble des sites hydro.

Par défaut, le web-service ne retourne pas les rôles associés aux sites hydro.

Droit de publication¶

Les droits de publication sont liés aux sites hydro à publier.

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.

Codes BNBV¶

Les codes BNBV associés aux sites hydro son retournés par le web-service uniquement pour les utilisateurs ayant le profil institutionnel.

Réponse du web-service¶

Le web-service renvoie un json hydrométrie contenant les intervenants à publier.

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
LbUsuelSiteHydro
TypSiteHydro
PrecisionTypSiteHydro
MnSiteHydro
ComplementLbSiteHydro
CoordSiteHydro : objet CoordSiteHydro
PkAmontSiteHydro
PkAvalSiteHydro
AltiSiteHydro: objet AltiSiteHydro
DtMajSiteHydro
BassinVersantSiteHydro
BassinVersantHydroSiteHydro
FuseauHoraireSiteHydro
StSiteHydro
DtPremDonSiteHydro
PremMoisEtiageSiteHydro
PremMoisAnHydSiteHydro
DureeCarCruSiteHydro
DroitPublicationSiteHydro
EssaiSiteHydro
InfluGeneSiteHydro
ComInfluGeneSiteHydro
SiteHydroAssocie : objet SiteHydroAssocie
CdEuMasseDEau
EntiteHydrographique objet EntiteHydrographique
LoisStatContexteSiteHydro : liste non vide d’objets LoiStatContexteSiteHydro
ImagesSiteHydro : liste non vide d’objets ImageSiteHydro
RolsContactSiteHydro : liste non vide d’objets RolContactSiteHydro
CdTronconHydrographique
EntsVigiCru : liste non vide d’objets EntVigiCru
Communes : liste non vide d’objets Commune
CdSiteHydroAncienRef
PluiesDeBassin : liste non vide d’objets PluieDeBassin
ZoneHydro : objet ZoneHydro
PrecisionCoursDEauSiteHydro
SitesHydroAmont : liste non vide d’objets SiteHydroAmont
SitesHydroAval : liste non vide d’objets SiteHydroAval
BNBV (objet BNBV) Sandre V2.1 ou CdBNBV (Sandre V2)

CoordSiteHydro¶

Propriétés de l’objet CoordSiteHydro:

CoordXSiteHydro
CoordYSiteHydro
ProjCoordSiteHydro

AltiSiteHydro¶

Propriétés de l’objet AltiSiteHydro:

AltitudeSiteHydro
SysAltimetriqueSiteHydro

SiteHydroAssocie

Propriété de l’objet SiteHydroAssocie:

CdSiteHydro

EntiteHydrographique¶

Propriétés de l’objet EntiteHydrographique:

CdEntiteHydrographique
NomEntiteHydrographique

LoiStatContexteSiteHydro¶

Propriétés de l’objet LoiStatContexteSiteHydro:

TypContexteLoiStat
TypLoiSiteHydro

ImageSiteHydro¶

Propriétés de l’objet ImageSiteHydro:

AdressedelImageSiteHydro
TypIllSiteHydro
FormatIllSiteHydro
ComImgSiteHydro

RolContactSiteHydro

Propriétés de l’objet RolContactSiteHydro:

CdContact
RoleContactSiteHydro
DtDebutContactSiteHydro
DtFinContactSiteHydro
DtMajRoleContactSiteHydro

EntVigiCru¶

Propriétés de l’objet EntVigiCru:

CdEntVigiCru
NomEntVigiCru

Commune¶

Propriétés de l’objet Commune:

CdCommune
LbCommune

PluieDeBassin¶

Propriétés de l’objet PluieDeBassin:

CdSiteMeteo
PonderationPluieDeBassin

ZoneHydro¶

Propriétés de l’objet ZoneHydro:

CdZoneHydro
LbZoneHydro

SiteHydroAmont et SiteHydroAval¶

Propriétés de l’objet SiteHydroAmont:

CdSiteHydro
LbSiteHydro

Objet BNBV¶

Propriété de l’objet BNBV

CdBNBV
SurfBNBV

Exemple¶

Sites hydro au format json¶

{
  "Scenario": {},
  "RefHyd": {
    "SitesHydro": [
      {
         "CdSiteHydro": "A1234567",
         "LbSiteHydro": "Lb",
         "LbUsuelSiteHydro": "Lb usuel",
         "TypSiteHydro": "VIRTUEL",
         "PrecisionTypSiteHydro": 8,
         "MnSiteHydro": "Mnémo",
         "ComplementLbSiteHydro": "complément",
         "CoordSiteHydro": {
           "CoordXSiteHydro": 1.85,
           "CoordYSiteHydro": 45.6,
           "ProjCoordSiteHydro": 26,
         },
         "PkAmontSiteHydro": 15.4,
         "PkAvalSiteHydro": 18.3,
         "AltiSiteHydro": {
           "AltitudeSiteHydro": 157.9,
           "SysAltimetriqueSiteHydro": 31
         },
         "DtMajSiteHydro": "2020-01-01T00:00:00",
         "BassinVersantSiteHydro": 1574.1,
         "BassinVersantHydroSiteHydro": 1864.2,
         "FuseauHoraireSiteHydro": 1,
         "StSiteHydro": 2,
         "DtPremDonSiteHydro": "2005-01-01T00:00:00",
         "PremMoisEtiageSiteHydro": 7,
         "PremMoisAnHydSiteHydro": 2,
         "DureeCarCruSiteHydro": 15,
         "DroitPublicationSiteHydro": 20,
         "EssaiSiteHydro": false,
         "InfluGeneSiteHydro": 3,
         "ComInfluGeneSiteHydro": "Cmnt influence",
         "SiteHydroAssocie": {
           "CdSiteHydro": "B1234567"
         },
         "CdEuMasseDEau": "FRIC1",
         "EntiteHydrographique": {
           "CdEntiteHydrographique": "A0000000",
           "NomEntiteHydrographique": "Entité hydro"
         },
         "LoisStatContexteSiteHydro": [
             {
               "TypContexteLoiStat": 1,
               "TypLoiSiteHydro": 2
             }
         ],
         "ImagesSiteHydro": [
           {
             "AdressedelImageSiteHydro": "https://foo.fr",
             "TypIllSiteHydro": 1,
             "FormatIllSiteHydro": "image/png",
             "ComImgSiteHydro": "Cmnt",
           }
         ],
         "RolsContactSiteHydro": [
           {
             "CdContact": "0",
             "RoleContactSiteHydro": "ADM",
             "DtDebutContactSiteHydro": "2010-01-01T00:00:00",
             "DtFinContactSiteHydro": "2018-01-01T00:00:00",
             "DtMajRoleContactSiteHydro": "2018-06-01T00:00:00"
           }
         ],
         "CdTronconHydrographique": "A0080300",
         "EntsVigiCru": [
           {
             "CdEntVigiCru": "000",
             "NomEntVigiCru": "Entité vigi"
           }
         ],
         "Communes": [
           {
             "CdCommune": "31055",
             "LbCommune": "Toulouse"
           }
         ],
         "CdSiteHydroAncienRef": "A7654321",
         "PluiesDeBassin": [
           {
             "CdSiteMeteo": "12345678",
             "PonderationPluieDeBassin": 13
           }
         ],
         "ZoneHydro": {
           "CdZoneHydro": "A1234",
           "LbZoneHydro": "Lb zone"
         },
         "PrecisionCoursDEauSiteHydro": "ruisseau",
         "SitesHydroAmont": {
           "CdSiteHydro": "D1234567",
           "LbSiteHydro": "lb2"
         },
         "SitesHydroAval": {
           "CdSiteHydro": "E1234567",
           "LbSiteHydro": "lb3"
         },
         "BNBV": {
           "CdBNBV": "CDBNBV",
           "SurfBNBV": 154
         }
      }
    ]
  }
}