Ajout d’un modèle de prévision¶

Ce web-service permet d’ajouter des modèles de prévision en PHyC.

Paramètres HTTP¶

Paramètre	Valeur
Route	modeleprevision
Méthode	POST
Contenu	mode de prévision format json

Droit de gestion¶

Il faut disposer du profil modélisateur pour ajouter un modèle de prévision.

Règles techniques¶

Le code modèle est obligatoire. Il ne doit pas être déjà présent en PHyC.

Contenu de la requête HTTP¶

La requête HTTP doit contenir un json hydrométrie contenant un modèle de prévision.

Json hydrométrie¶

Schéma de validation¶

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://phyc.org/ws/ajouterModelePrevision.json",
  "type": "object",
  "properties": {
    "Scenario": {
      "type": "object"
    },
    "RefHyd": {
      "type": "object",
      "properties": {
        "ModelesPrevision": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "CdContact": {"type": "string"},
              "CdModelePrevision": {"type": "string"},
              "LbModelePrevision": {"type": "string"},
              "TypModelePrevision": {"type": "integer"},
              "DescModelePrevision": {"type": "string"},
              "SitesHydro": {
                "type": "array",
                "items" : {
                  "type": "object",
                  "properties": {
                    "CdSiteHydro": {"type": "string"}
                  },
                  "required": ["CdSiteHydro"],
                  "additionalProperties": false
                }
              }
            },
            "required": ["CdContact", "CdModelePrevision"],
            "additionalProperties": false
          },
          "minItems": 1
        }
      },
      "required": ["ModelesPrevision"],
      "additionalProperties": false
    }
  },
  "required": ["Scenario", "RefHyd"],
  "additionalProperties": false
}

Les attributs RefHyd (associé à l’objet Refhyd) et Scenario sont obligatoires;
L’objet RefHyd ne doit contenir qu’un seul attribut ModelesPrevision associé à une liste non vide d’objets ModelePrevision;
L’objet ModelePrevision doit contenir les attributs CdContact et CdModelePrevision;
L’objet ModelePrevision ne doit pas contenir l’attribut DtMajModelePrevision.

Réponse du web-service¶

En cas de succès, le web-service retournera un json hydrométrie contenant le modèle ajouté.

Le web-service rajoutera l” attribut DtMajModelePrevision au modèle.