Modification d’un événement associé à une station hydro¶

Ce web-service permet de modifier des événements à des stations hydro.

Paramètres HTTP¶

Paramètre	Valeur
Route	evenement/stationhydro
Méthode	PUT
Contenu	événement au format json

Droits de gestion¶

l’utilisateur doit posséder le rôle ADM, POLE2, POLE3, POLE4 ou PREVI sur la station hydro pour modifier un événement.

Règles techniques¶

La station hydro et l’événement doivent exister.

Contenu de la requête HTTP¶

La requête HTTP doit contenir un json hydrométrie contenant un événement.

Json hydrométrie¶

Schéma de validation¶

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://phyc.org/ws/modifierEvenementStationHydro.json",
    "type": "object",
    "properties": {
        "Scenario": {
            "type": "object"
        },
        "Donnees": {
            "type": "object",
            "properties": {
                "Evenements": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "properties": {
                            "CdContact": {"type": "string"},
                            "CdStationHydro": {"type": "string"},
                            "DtEvenement": {"type": "string", "format": "date-time"},
                            "TypEvenement": {"type": "integer"},
                            "DescEvenement": {"type": "string"},
                            "TypPubliEvenement": {"type": "integer"},
                            "RessEvenement": {
                                "type": ["array", "null"],
                                "items": {
                                    "type": "object",
                                    "properties": {
                                        "UrlResEvenement": {"type": "string"},
                                        "LbResEvenement": {"type": ["string", "null"]}
                                    },
                                    "required": ["UrlResEvenement"],
                                    "additionalProperties": false
                                },
                                "minItems": 1
                            },
                            "DtFinEvenement": {"type": ["string", "null"], "format": "date-time"}
                        },
                        "required": ["CdContact", "CdStationHydro", "DtEvenement", "DescEvenement"],
                        "additionalProperties": false
                    },
                    "minItems": 1
                }
            },
            "required": ["Evenements"],
            "additionalProperties": false
        }
    },
    "required": ["Scenario", "Donnees"],
    "additionalProperties": false
}

Les attributs Donnees (associé à l’objet Donnees) et Scenario sont obligatoires;
L’objet Donnees ne doit contenir qu’un seul attribut Evenements associé à une liste non vide contenant des objets Evenement;
L’objet Evenement doit contenir les attributs CdContact, CdStationHydro, DtEvenement et DescEvenement.
L’objet Evenement ne doit pas contenir les attributes CdSiteHydro, CdSiteMeteo et DtMajEvenement;
RessEvenement doit être être une liste non vide d’objet ResEvenement;
ResEvenement doit contenir l’attribut UrlResEvenement;

Réponse du web-service¶

En cas de succès, le web-service retournera un json hydrométrie contenant l’événement passé en paramètre.

Le web-service rajoutera l’attribut DtMajEvenement à l’événement.