Suppression d’un épisode

Ce web-service permet de supprimer en épisode.

L’épisode n’est pas supprimé mais désactivé.

Il est donc possible de le rendre actif en contactant l’administrateur de la base de données BDPREV.

Les épisodes désactivés de plus d’un an sont supprimés définitivement.

Paramètres HTTP

Paramètre

Valeur

Route

episode

Méthode

DELETE

Contenu

épisode format json

Contenu

Le contenu doit contenir un épisode au format avec une unique propriété: CdEpisode. Le web-service renverra une erreur en cas de non conformité.

Schéma de validation

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://bdprev.org/deleteepisode.json",
  "type": "object",
  "properties": {
    "CdEpisode": {
      "type": "integer"
    }
  },
  "required": ["CdEpisode"],
  "additionalProperties": false
}

Exemple d’entrée

{
   "CdEpisode": 1
}

Messages spécifiques d’erreurs

  • L’épisode {cdepisode} est déja désactivé

  • Episode de code {cdepisode} inexistant

Retour du web-service

Le web-service renvoie l’épisode dans son intégralité en ajoutant la date de désactivation.

{
   "CdEpisode": 1,
   "DtDesactivation": "2024-01-01T00:00:00"
}

Droit de gestion

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