Publication d’alarmes hydro¶
Paramètres HTTP¶
Paramètre |
Valeur |
|---|---|
Route |
alarmeshydro |
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 entités |
list(str) |
F |
type |
type d’alarme |
int |
F |
cdseuils |
liste de codes de seuil |
list(int) |
F |
gravites |
liste d’indices de gravité |
list(int) |
F |
dtdebut |
Date de début |
datetime |
O |
dtfin |
Date de fin |
datetime |
F |
natures |
liste de natures |
list(int) |
F |
Filtres date¶
Les dates de debut et de fin sont relatives aux dates d’activation et de désactivation des alarmes.
Date de fin¶
En l’absence de date de fin, le web-servie renvoie l’ensemble des alarmes actives dont la date d’activation dépasse le filtre dtdebut.
En présence de date de fin, le web service renverra l’ensemble des alarmes actives et inactives pour la période de temps [dtdebut-dtfin].
Réponse du web-service¶
Le web-service renvoie un json hydrometrie contenant les alarmes hydro à publier.
Le json hydrométrie contient les deux propriétés Scenario et Donnees.
Donnees¶
L’objet Donnees contiendra une unique propriété Alarms.
Alarms est une liste non vide d’objets Alarm.
Alarm¶
Propriété de l’objet Alarm:
DtAlarm
TypAlarm
MessAlarm
AlarmActivee
CdSiteHydro ou CdStationHydro
AlarmsSeuil : liste non vide d’objets AlarmSeuil
AlarmSeuil¶
Propriété de l’objet AlarmSeuil
CdSeuilHydro
CdCapteur ou CdStationHydro ou CdSiteHydro
DtObsHydro
Exemple¶
{
"Scenario": {},
"Donnnees": {
"Alarms": [
{
"DtAlarm": "2024-01-01T09:00:00",
"TypAlarm": 2,
"AlarmActivee": true,
"CdStationHydro": "A13456789",
"AlarmsSeuil": [
{
"CdSeuilHydro": 0,
"CdCapteur": "A1345678987",
"DtObsHydro": "2024-01-01T08:00:00",
}
]
}
],
}
}