Publication des qualifications des années hydrométriques¶

Paramètres HTTP¶

Paramètre	Valeur
Route	qualifannee
Méthode	POST ou PUT
Contenu	des qualifications des années au format json

Droit de gestion¶

Il faut posséder le droit ADM ou POLE2 sur le site ou la station.

Règles techniques¶

Le site ou la station doit exister.

Contenu de la requête HTTP¶

La requête HTTP doit contenir un json hydrométrie contenant des qualifications d’années hydrométriques.

Json hydrométrie¶

Schéma de validation¶

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://phyc.org/ws/gererValidAnnee.json",
    "type": "object",
    "properties": {
        "Scenario": {
            "type": "object"
        },
        "Donnees": {
            "type": "object",
            "properties": {
                "ValidsAnneeHydro": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "properties": {
                            "AnneeValidAnneeHydro": {"type": "integer"},
                            "CdSiteHydro": {"type": "string"},
                            "CdStationHydro": {"type": "string"},
                            "QualifValidAnneeHydro": {"type": "integer"},
                            "ComValidAnneeHydro": {"type": ["string", "null"]}
                        },
                        "required": ["AnneeValidAnneeHydro", "QualifValidAnneeHydro"],
                        "oneOf": [
                            {"required":  ["CdSiteHydro"]},
                            {"required":  ["CdStationHydro"]}
                        ],
                        "additionalProperties": false
                    },
                    "minItems": 1
                }
            },
            "required": ["ValidsAnneeHydro"],
            "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 ValidsAnneeHydro qui doit être une liste non vide d’objets ValidAnneeHydro;
L’objet ValidAnneeHydro doit contenir obligatoirement les attributs AnneeValidAnneeHydro, QualifValidAnneeHydro et un des deux attributs CdSiteHydro et CdStationHydro;
L’attribut ComValidAnneeHydro de l’objet ValidAnneeHydro est facultatif;

Réponse du web-service¶

En cas de succès, le web-service retournera un json hydrométrie contenant les qualifications insérées.

Il rajoutera les attributs suivants:

DtMajValidAnneeHydro
DispoHValidAnneeHydro uniquement pour les stations
DispoQValidAnneeHydro