Publication d’observations hydro¶

Ce web-service permet de publier des observations hydro à partir d’entités hydro (sites hydro, stations hydro et capteurs).

Au niveau d’un site, on ne peut publier que des débits.

Au niveau d’un capteur, on ne peut publier que des observations de la grandeur du capteur.

Les observations hydrométriques brutes (statut = 4) et corrigées (statut= 8) sont associées à un capteur tandis que les observations pré-validées (statut = 12) et validées (statut = 16) sont associées à une station.

Les observations liées à un capteur sont remontées à la station lorsque le capteur est actif. Les observations de débit remontent au site si la station est active.

Paramètres HTTP¶

Paramètre	Valeur
Route	obsshydro
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 site et/ou de codes de station et/ou de codes de capteur	list(str)	O
grandeur	grandeurs(combinaison de H, Q et V)	str	O
statuts	Liste de statuts	list(int)	F
qualifications	Liste de qualifications	list(int)	F
methodes	Liste de méthodes	list(int)	F
plusvalide	Notion de plus valide	bool	F
dtdebut	Date de début	datetime	O/F
dtfin	Date de fin	datetime	F
dtinsdebut	date de début d’insertion	datetime	F
dtinsfin	Date de fin d’insertion	datetime	F
pdt	Publication à pas de temps	int	F
plusrecent	observations les plus récentes	bool	F
asynchrone	Publication asynchrone	bool	F
email	email lié à la publication asynchrone	str	F

Filtre pdt¶

Si ce paramètre est défini, le web-service renverra des observations interpolées à partir de la date de début au pas de temps défini.

Le pas de temps doit être un diviseur de 60.

Le pas de temps est exprimé en minutes.

La publication d’observations à pas de temps est plus lente que la publication d’observations élémentaires puisque le web-service va:

interpoler les observations;
calculer des débits à partir de la courbe de tarage.

Filtre plusvalide¶

Avec le filtre plusvalide, le web-service ne renverra que les observations les plus valides, c’est-à-dire les données de statut maximal et les plus récentes.

À un instant t, on ne peut avoir qu’une seule donnée la plus valide.

Combinaison du filtre statut avec plusvalide¶

Le web-service retourne parmi les données les plus valides, les données du statut spécifié.

Le web-service ne renvoie pas les données les plus valides d’un certain statut.

Filtre plusrecent¶

Si le filtre plusrecent est défini est prend comme valeur true, alors:

Le web-service renvoie les observations les plus récentes pour chaque entité, grandeur et statut.
les filtres date sont non obligatoires;

Filtres date¶

En présence de date de début et de fin, le web-service vérifie que la date début est antérieure à la date de fin.

Interpolation des observations¶

Les interpolations à pas de temps sont uniquement réalisées à partir des données les plus valides.

Il n’y a pas d’interpolation en présence de discontinuités.

Les interpolations sont ensuite filtrées par statut si le filtre statuts est renseigné.

Interpolation des hauteurs¶

L’interpolation des hauteurs est linéaire.

Interpolation des débits (stations et sites)¶

Pour les stations standards, la PHyC interpole tout d’abord les hauteurs puis calcule les débits à partir de la courbe de correction et de la courbe de tarage active.

Pour les stations de type débitmètre, l’interpolation des débits est linéaire.

Limite publication synchrone/asynchrone¶

Avant de lancer le traitement, le web-service vérifie que le nombre d’observations ne dépasse pas les limites synchrone ou asynchrone de publication d’observations hydro.

Soit Nent, le nombre d’entités et Ngrd, le nombre de grandeur à publier (1, 2 ou 3).

Le web-service calcule le nombre théorique maximal :

\[N_{obs} = N_{ent} \times N_{grd} \times \frac {min((dtfin – dtdebut),(dtinsfin – dtinsdebut))} {pdt}\]

avec les périodes de publication (dtmesurefin – dtmesure) et (dtinsertionfin – dtinsertiondebut) exprimées en minutes et pdt = 5 si on demande des observations élémentaires.

Pour une publication portant sur 5 entités, avec comme grandeurs H et Q et sur une période de 30 jours :

\[N_{obs} = 5 \times 2 \times \frac {43200} {5} = 86400\]

Si le nombre théorique d’observations est supérieure à la limite du web-service, alors le web-service renvoie une erreur.

Droits de publication¶

Les droits de publication dépendent des droits de publication des sites et des stations.

Pour publier des observations sur une station ou un capteur, il faut avoir les bons droits sur le site dont dépend la station et la station.

Sites publics et stations publiques ou « publiques sans ct et cc »¶

Il n’est pas nécessaire d’être authentifié pour publier des observations sur ces entités.

Stations de droit « Hauteur publique »¶

Il n’est pas nécessaire d’être authentifié pour publier des hauteurs sur ces stations.

Pour publier des débits, l’utilisateur doit être authentifié et avoir le profil institutionnel ou posséder un droit sur la station.

Stations de droit « Débit public »¶

Il n’est pas nécessaire d’être authentifié pour publier des débits sur ces stations.

Pour publier des hauteurs, l’utilisateur doit être authentifié et avoir le profil institutionnel ou posséder un droit sur la station.

Sites et stations restreints¶

L’utilisateur doit être authentifié et avoir le profil institutionnel ou posséder un droit sur le site ou la station.

Sites et stations privés¶

L’utilisateur doit être authentifié et posséder un droit sur le site ou la station.

Zone de publication de la courbe de tarage¶

En présence d’une limite inférieure et/ou supérieure de publication d’une courbe de tarage, les débits en dehors de la zone de publication ne sont pas publics.

Pour publier des débits en dehors de la zone de publication, l’utilisateur doit être authentifié et avoir le profil institutionnel.

Réponse du web-service en mode asynchrone¶

En mode asynchrone, le web-service enregistrera la demande de publication. En retour, la PHyC fournit deux paramètres.

idpublication: identifiant de publication
url : le lien de récupération de la demande

Réponse du web-service en mode synchrone¶

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

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

Données¶

L’objet Données contiendra l’unique propriété SeriesObsHydro.

SeriesObsHydro est une liste non vide d’objets SerieObsHydro.

SerieObsHydro¶

Propriétés de l’objet SerieObsHydro:

CdSiteHydro ou CdStationHydro ou CdCapteur
GrdSerieObsHydro
DtDebSerieObsHydro
DtFinSerieObsHydro
DtProdSerieObsHydro
SysAltiSerieObsHydro
SeriePerimSerieObsHydro
PDTSerieObsHydro
CdContact
ObssHydro : liste non vide d’objets ObsHydro

ObsHydro¶

Propriétés de l’objet ObsHydro:

DtObsHydro
ResObsHydro
QualifObsHydro
MethObsHydro
ContObsHydro
StObsHydro

Exemple¶

Observations hydro au format json¶

{
  "Scenario": {},
  "Donnnees": {
    "SeriesObsHydro": [
      {
        "CdStationHydro": "A123456789",
        "GrdSerieObsHydro": "H",
        "DtDebSerieObsHydro": "2021-01-01T00:00:00",
        "DtFinSerieObsHydro": "2021-01-02T00:00:00",
        "DtProdSerieObsHydro": "2021-01-03T00:00:00",
        "SysAltiSerieObsHydro": 31,
        "PDTSerieObsHydro": 5,
        "CdContact": "0",
        "ObssHydro" : [
          {
            "DtObsHydro" : "2021-01-01T00:30:00",
            "ResObsHydro" : 157,
            "QualifObsHydro" : 16,
            "MethObsHydro" : 0,
            "ContObsHydro" : 0,
            "StObsHydro" : 4
          }
        ]
      }
    ]
  }
}