Ajout d’un modèle de prévision

Paramètres HTTP

Paramètre

Valeur

Route

modele

Méthode

POST

Contenu

modèle au format json

Contenu de la requête HTTP

Les propriétés CdModelePrevision, LbModelePrevision », TypModelePrevision, Classification, Plateforme, Statut et Usage sont obligatoires.

Le modèle doit être conforme au schéma suivant:

Schéma de validation

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://bdprev.org/addmodele.json",
  "type": "object",
  "properties": {
    "CdModelePrevision": {
      "type": "string"
    },
    "LbModelePrevision": {
      "type": "string"
    },
    "TypModelePrevision": {
      "type": "integer"
    },
    "DescModelePrevision": {
      "type": "string"
    },
    "CdContact": {
      "type": "string"
    },
    "Classification": {
      "type": "integer"
    },
    "Plateforme": {
      "type": "string"
    },
    "Statut": {
      "type": "integer"
    },
    "Usage": {
      "type": "integer"
    },
    "SitesHydro" :{
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "CdSiteHydro": {"type": "string"}
        }
      },
      "required": ["CdSiteHydro"],
      "additionalProperties": false
    }
  },
  "required": [
    "CdModelePrevision",
    "LbModelePrevision",
    "TypModelePrevision",
    "Classification",
    "Plateforme",
    "Statut",
    "Usage"
  ],
  "additionalProperties": false
}

Exemple d’entrée

{
  "CdModelePrevision": "00nXXX0000",
  "LbModelePrevision": "Libellé du modèle",
  "TypModelePrevision": 4,
  "DescModelePrevision": "Description",
  "CdContact": "1234",
  "Classification": 0,
  "Plateforme": "GRP",
  "Statut": 1,
  "Usage": 1,
  "SitesHydro": [{
    "CdSiteHydro": "A1234567"
  }]
}

Droit de gestion

L’utilisateur du web-service doit être authentifié et disposer du profil gestionnaire de modèles.

Retour du web-service

Le web-service retournera le modèle de prévision au format json.

La BDPREV ajoute au modèle la date de mise à jour (DtMajModelePrevision).

Exemple de sortie

{
  "CdModelePrevision": "00nXXX0000",
  "LbModelePrevision": "Libellé du modèle",
  "TypModelePrevision": 4,
  "DescModelePrevision": "Description",
  "CdContact": "1234",
  "DtMajModelePrevision": "2024-10-07T09:00:00",
  "Classification": 0,
  "Plateforme": "GRP",
  "Statut": 1,
  "Usage": 1,
  "SitesHydro": [{
    "CdSiteHydro": "A1234567"
  }]
}