Ajout d’un événement à un site hydro¶

Ce web-service permet d’ajouter des événements à des sites hydro.

Paramètres HTTP¶

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

Droits de gestion¶

l’utilisateur doit posséder le rôle ADM ou POLE2, POLE3 ou PREVI sur le site hydro pour ajouter un événement.

Règles techniques¶

Le site doit 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/ajouterEvenementSiteHydro.json",
    "type": "object",
    "properties": {
        "Scenario": {
            "type": "object"
        },
        "Donnees": {
            "type": "object",
            "properties": {
                "Evenements": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "properties": {
                            "CdContact": {"type": "string"},
                            "CdSiteHydro": {"type": "string"},
                            "DtEvenement": {"type": "string", "format": "date-time"},
                            "TypEvenement": {"type": "integer"},
                            "DescEvenement": {"type": "string"},
                            "TypPubliEvenement": {"type": "integer"},
                            "RessEvenement": {
                                "type": "array",
                                "items": {
                                    "type": "object",
                                    "properties": {
                                        "UrlResEvenement": {"type": "string"},
                                        "LbResEvenement": {"type": "string"}
                                    },
                                    "required": ["UrlResEvenement"],
                                    "additionalProperties": false
                                },
                                "minItems": 1
                            },
                            "DtFinEvenement": {"type": "string", "format": "date-time"}
                        },
                        "required": ["CdContact", "CdSiteHydro", "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, CdSiteHydro, DtEvenement et DescEvenement.
L’objet Evenement ne doit pas contenir les attributs CdSiteMeteo, CdStationHydro 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.