Publication des rôles de contacts de sites hydro (déprécié)¶

Ce web-service permet de publier les rôles de contacts sur des sites hydro.

Paramètres HTTP¶

Paramètre	Valeur
Route	contactsitehydro
Méthode	GET

Paramètres¶

Nom	Description	Type	O/F
cdsiteshydro	Liste de codes de sites 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 ractif=false, le web-service renvoie uniquement les rôles désactivés.

Droit de publication¶

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

Pour un site hydrométrique public (droit de publication du site égal à « Hauteur publique »(12), « Débit public »(14) ou « Public »(10)), n’importe quel utilisateur peut avoir accès aux données du site qu’il soit authentifié ou non.

Pour accéder aux données d’un site hydrométrique privé (droit de publication du site égal à « Privé »(30)) ou restreint (droit de publication du site égal à « Restreint »(20)), l’authentification de l’utilisateur est obligatoire. Dans le cas d’un site restreint, 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 données du site. Et dans le cas d’un site privé, le contact doit être lié à l’entité avec n’importe quel rôle, pour pouvoir afficher les données du site.

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
RolsContactSiteHydro : liste non vide d’objets RolContactSiteHydro.

RolContactSiteHydro¶

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

CdContact
RoleContactSiteHydro
DtDebutContactSiteHydro
DtFinContactSiteHydro
DtMajRoleContactSiteHydro

Exemple¶

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

{
  "Scenario": {},
  "RefHyd": {
    "SitesHydro": [
      {
        "CdSiteHydro": "A0000000",
        "RolsContactSiteHydro": [
          {
            "CdContact": "0",
            "RoleContactSiteHydro": "ADM",
            "DtDebutContactSiteHydro": "2010-01-01T00:00:00",
            "DtFinContactSiteHydro": "2020-01-01T00:00:00",
            "DtMajRoleContactSiteHydro": "2021-01-01T00:00:00"
          }
        ]
      }
    ]
  }