Publication des rôles de contacts de stations hydro¶

Ce wzeb-service permet de publier les rôles de contacts sur des stations hydro.

Paramètres HTTP¶

Paramètre	Valeur
Route	contactsstationhydro
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
cdstationshydro	Liste de codes de stations hydro	list(str)	O
dtmaj	Date de mise à jour	datetime	F
actif	Rôle actif bool		F

Paramètre actif¶

Par défaut le web-service ne renvoie que les rôles actifs.

Avec le paramètre roleactif=false, le web-service renvoie les rôles désactivés.

Droit de publication¶

Les droits de publication appliqués pour ce service web sont ceux liés aux stations hydrométriques passées en paramètre (cdstationshydro).

Pour une station hydrométrique publique (droit de publication < 20), n’importe quel utilisateur peut avoir accès aux rôles des contacts.

Dans le cas d’une station restreinte (droit de publication = 20), le contact correspondant à l’utilisateur doit avoir le profil institutionnel ou être lié à l’entité avec n’importe quel rôle, pour pouvoir afficher les rôles des contacts de la station.

Dans le cas d’une station privée (droit de publication = 30), le contact doit être lié à l’entité avec n’importe quel rôle, pour pouvoir afficher les rôles des contacts de la station.

Réponse du web-service¶

Le web-servie renvoie un json hydrométrie contenant des objets SiteHydro contenant chacun une liste d’objets RolContactSiteHydro.

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¶

L’objet SiteHydro contiendra les propriétés suivantes:

CdSiteHydro
StationsHydro : liste non vide d’objets StationHydro.

StationHydro¶

Chaque objet StationHydro pourra contenir les propriétés suivantes:

CdStationHydro
RolsContactStationHydro : liste non vide d’objets RolContactStationHydro

RolContactStationHydro¶

Chaque objet RolContactStationHydro pourra contenir les propriétés suivantes:

CdContact
RoleContactStationHydro
DtDebutContactStationHydro
DtFinContactStationHydro
DtMajRoleContactStationHydro

Exemple¶

Rôles de contacts sur des stations hydro au format json¶

{
  "Scenario": {},
  "RefHyd": {
    "SitesHydro": [
      {
        "CdSiteHydro": "A0000000",
        "StationsHydro": [
          {
            "CdStationHydro": "A000000000",
            "RolsContactStationHydro": [
              {
                "CdContact": "0",
                "RoleContactStationHydro": "ADM",
                "DtDebutContactStationHydro": "2010-01-01T00:00:00",
                "DtFinContactStationHydro": "2020-01-01T00:00:00",
                "DtMajRoleContactStationHydro": "2021-01-01T00:00:00"
              }
            ]
          }
        ]
      }
    ]
  }