Ajout d’un rôle d’un contact à un site hydro¶

Ce web-service permet d’ajouter un rôle à un contact sur une site hydro.

Paramètres HTTP¶

Paramètre	Valeur
Route	contactsitehydro
Méthode	POST
Contenu	un rôle d’un contact sur un site hydro

Droit de gestion¶

Pour ajouter un rôle d’un contact, il faut être administrateur du site hydro.

Règles techniques¶

Le site hydro doit exister.
Le contact à associer au site hydrologique doit être actif.
Le rôle à ajouter doit appartenir à la liste suivante: ADM, POLE2, PREVI, VISU.

Si le contact dispose déjà du rôle, la PHyC n’émet pas d’erreur.

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 site hydro.

Json hydrométrie¶

Schéma de validation¶

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://phyc.org/ws/ajouterContactSiteHydro.json",
  "type": "object",
  "properties": {
    "Scenario": {
      "type": "object"
    },
    "RefHyd": {
      "type": "object",
      "properties": {
        "SitesHydro": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "CdSiteHydro": {"type": "string"},
              "RolsContactSiteHydro": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "CdContact": {"type":  "string"},
                    "RoleContactSiteHydro": {"type":  "string"}
                  },
                  "required": ["CdContact", "RoleContactSiteHydro"],
                  "additionalProperties": false
                },
                "minItems": 1
              }
            },
            "required": ["CdSiteHydro", "RolsContactSiteHydro"],
            "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 RolsContactSiteHydro;
L’attribut RolsContactSiteHydro doit être une liste non vide d’objets RolContactSiteHydro;
L’objet RolContactSiteHydro doit contenir uniquement les attributs CdContact et RoleContactSiteHydro.

Réponse du web-service¶

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

Le web-service rajoutera les attributs DtDebutContactSiteHydro et DtMajRoleContactSiteHydro au rôle du contact.