Publication de pluies de bassin

Ce web-service permet de publier des pluies de bassin.

Paramètres HTTP

Paramètre

Valeur

Route

pluiesbassin

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

cdsiteshydro

Liste de codes de sites hydro

list(str)

O

duree

Durée des cumuls

str

F

statuts

Liste des 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

dtfin

Date de fin

datetime

F

asynchrone

Publication asynchrone

bool

F

email

email lié à la publication asynchrone

str

F

Filtre durée

En l’absence du filtre durée, la durée des cumuls correspondra au ppcm des pas de temps des grandeurs RR des sites météo.

Si le filtre durée est défini, les valeurs autorisées sont:
  • un multiple du ppcm des pas de temps,

  • 60 (cumul horaire),

  • 1440 (cumul journalier).

Droits de publication

Les droits de publication du web-service dépendent des droits de publication des sites hydro.

Il n’est pas nécessaire d’être authentifier pour publier des pluies de bassin de sites hydro publics.

L’authentification est nécessaire pour les autres sites hydro.

Pour les sites « restreints », l’utilisateur doit posséder le profil institutionnel ou posséder un droit sur le site.

Pour les sites privés, l’utilisateur doit posséder un rôle sur le site hydro.

Réponse web-service mode asynchrone

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

  • idpublication: identifiant de ublication

  • url : le lien de récupération de la demande

Réponse web-service mode synchrone

Le web-service renvoie un json hydrométrie contenant les observations météo à 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é SeriesObsElaborMeteo.

SeriesObsElaborMeteo est une liste non vide d’objets SerieObsElaborMeteo.

SerieObsElaborMeteo

Propriétés de l’objet SerieObsElaborMeteo:

  • CdSiteHydro

  • CdGrdSerieObsElaborMeteo

  • TypSerieObsElaborMeteo

  • DtDebSerieObsElaborMeteo

  • DtFinSerieObsElaborMeteo

  • DureeSerieObsElaborMeteo

  • ObssElaborMeteo : liste non vide d’objets ObsElaborMeteo

ObsElaborMeteo

Propriétés de l’objet ObsElaborMeteo:

  • DtObsElaborMeteo

  • ResObsElaborMeteo

  • IndiceQualObsElaborMeteo

  • QualifObsElaborMeteo

  • MethObsElaborMeteo

  • StObsElaborMeteo

Exemple

Observations météo au format json
{
  "Scenario": {},
  "Donnnees": {
    "SerieObsElaborMeteo": [
      {
        "CdSiteHydro" : "A1234567",
        "CdGrdSerieObsElaborMeteo" : "RR",
        "TypSerieObsElaborMeteo" : 1,
        "DtDebSerieObsElaborMeteo" : "2020-01-01T00:00:00",
        "DtFinSerieObsElaborMeteo" : "2020-01-01T01:00:00",
        "DureeSerieObsElaborMeteo" : "2024-01-01T01:00:00",
        "ObssElaborMeteo": [
          {
            "DtObsElaborMeteo" : "2020-01-01T01:00:00",
            "ResObsElaborMeteo" : 15,
            "IndiceQualObsElaborMeteo" : 100,
            "QualifObsElaborMeteo" : 16,
            "MethObsElaborMeteo" : 0,
            "StObsElaborMeteo" : 4
          }
        ]
      }
    ]
  }
}