Suppression d’un rôle d’un contact à une station hydro

Ce web-service permet de supprimer un rôle d’un contact sur une station hydro.

Paramètres HTTP

Paramètre

Valeur

Route

contactstationhydro

Méthode

DELETE

Contenu

un rôle d’un contact sur un station hydro

Droit de gestion

Pour supprimer un rôle d’un contact, il faut être administrateur de la station hydro.

Contenu de la requête HTTP

La requête HTTP doit contenir un json hydrométrie contenant un rôle d’un contact sur un station hydro.

Règles techniques

  • le site hydro et la station doivent exister

  • la station doit dépendre du site hydro

  • le contact doit exister et être actif

  • Le dernier rôle ADM d’un station hydro ne peut pas être supprimé

  • Le rôle à ajouter doit appartenir à la liste suivante: ADM, POLE2, POLE3, POLE4, PREVI, VISU

Json hydrométrie

Schéma de validation
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://phyc.org/ws/supprimerContactStationHydro.json",
  "type": "object",
  "properties": {
    "Scenario": {
      "type": "object"
    },
    "RefHyd": {
      "type": "object",
      "properties": {
        "SitesHydro": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "CdSiteHydro": {"type": "string"},
              "StationsHydro": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "CdStationHydro": {"type":  "string"},
                    "RolsContactStationHydro": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "CdContact": {"type":  "string"},
                          "RoleContactStationHydro": {"type":  "string"}
                        },
                        "required": ["CdContact", "RoleContactStationHydro"],
                        "additionalProperties": false
                      },
                      "minItems": 1
                    }
                  },
                  "required": ["CdStationHydro", "RolsContactStationHydro"],
                  "additionalProperties": false
                },
                "minItems": 1
              }
            },
            "required": ["CdSiteHydro", "StationsHydro"],
            "additionalProperties": false
          },
          "minItems": 1
        }
      },
      "required": ["SitesHydro"],
      "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 SitesHydro associé à une liste non vide d’objets SiteHydro;

  • L’objet SiteHydro doit contenir les attributs CdSiteHydro et StationsHydro;

  • L’attribut StationsHydro doit être une liste contenant un unique objet StationHydro;

  • L’objet StationHydro doit contenir uniquement les attributs CdStationHydro et RolsContactStationHydro;

  • L’attribut RolsContactStationHydro doit être une liste non vide d’objets RolContactStationHydro;

  • L’objet RolContactStationHydro doit contenir uniquement les attributs CdContact et RoleContactStationHydro.

Erreurs

La PHyC émet des erreurs si:

  • le paramètre idsession n’est pas fourni ou est périmé

  • l’utilisateur ne dispose pas des droits pour supprimer un rôle au site météo

  • le json n’est pas conforme

  • suppression d’un rôle non autorisé

  • le site météo n’existe pas

  • le contact n’existe pas ou n’est pas actif

Réponse du web-service

En cas de succès, le web-service retournera un json hydrométrie contenant le rôle du contact désactivé.

Le web-service rajoutera les attributs DtFinContactStationHydro et DtMajRoleContactStationHydro au rôle du contact.