Désactivation de points d’une courbe de correction¶

Ce web-service permet de désactiver des points pivot d’une courbe de correction en PHyC.

Paramètres HTTP¶

Paramètre	Valeur
Route	courbecorrection/desactivationpoints
Méthode	PUT
Contenu	courbe de correction au format json

Droit de gestion¶

Il faut disposer du rôle ADM ou POLE2 sur la station hydro pour gérer une courbe de correction.

Règles techniques¶

La PHyC vérifie qu’après désactivation de points pivot, la courbe possède encore au moins de 2 points pivot.

Lorsque l’on désactive les premiers points d’une courbe de correction, la PHYC vérifie que le nouveau premier point de la courbe de correction a son delta à 0.

L’appel du web-service échouera dans les cas suivants :

absence de courbe de correction;
un des points à désactiver n’est pas actif ou n’existe pas;
delta du premier point de la courbe de correction différent de 0;
la courbe de correction finale comporte moins de deux points.

Contenu de la requête HTTP¶

La requête HTTP doit contenir un json hydrométrie contenant une courbe de correction.

Json hydrométrie¶

Schéma de validation¶

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://phyc.org/ws/gererCourbeCorrectionDesactivationPoints.json",
    "type": "object",
    "properties": {
        "Scenario": {
            "type": "object"
        },
        "Donnees": {
            "type": "object",
            "properties": {
                "CourbesCorrH": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "properties": {
                            "CdStationHydro": {"type": "string"},
                            "LbCourbeCorrH": {"type": ["string", "null"]},
                            "ComCourbeCorrH": {"type": ["string", "null"]},
                            "PointsPivot": {
                                "type": "array",
                                "items": {
                                    "type": "object",
                                    "properties": {
                                        "DtPointPivot": {"type": "string", "format": "date-time"}
                                    },
                                    "required": ["DtPointPivot"],
                                    "additionalProperties": false
                                },
                                "minItems": 1
                            }
                        },
                        "required": ["CdStationHydro", "PointsPivot"],
                        "additionalProperties": false
                    },
                    "minItems": 1
                }
            },
            "required": ["CourbesCorrH"],
            "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 CourbesCorrH associé à une liste ne contenant qu’un seul objet CourbeCorrH;
Les attributs CdStationHydro et PointsPivot de l’objet CourbeCorrH sont obligatoires;
PointsPivot doit être une liste non vide d’objet PointPivot;
les attributs DeltaHPointPivot, DtActivationPointPivot et DtDesactivationPointPivotes des objets PointPivot ne doivent pas apparaître;
l’attribut DtMajCourbeCorrH de l’objet CourbeCorrH ne doit pas être présent.

Recalcul¶

L’appel du web-service va générer des recalculs asynchrones sur une partie ou l’ensemble de la courbe de correction.

Réponse du web-service¶

En cas de succès, le web-service retournera un json hydrométrie contenant la courbe de correction passée en paramètre.

Le web-service rajoutera l’attribut DtMajCourbeCorrH à la courbe de correction et les attributs DtDesactivationPointPivot aux points désactivés.