Modification d’un contact¶

Ce web-service permet de modifier un contact en PHyC.

Paramètres HTTP¶

Paramètre	Valeur
Route	contact
Méthode	POST
Contenu	contact au format json

Droit de gestion¶

Hormis son profil, un utilisateur peut modifier ses informations personnelles.

Pour modifier un contact (autre que l’utilisateur du web-service), il faut être gestionnaire d’une zone hdyro pour modifer un contact.

Il faut être administrateur national pour ajouter ou retirer le profil d’administrateur national.

Il faut avoir le profil modélisateur pour ajouter ou retirer le profil modélisateur.

Règles techniques¶

Un contact peut être désactivé en utilisant l’attribut DtDesactivationContact. Un contact désactivé ne peut pas être modifié.

Pour réactiver un contact, il faut utiliser ce web-service avec la balise DtDesactivationContact à vide.

Pour modifier le profil d’un contact l’utilisateur devra au moins avoir des droits équivalents à ceux de sa cible.

Seul un administrateur national peut modifier l’intervenant lié à un contact. Si l’utilisateur du web-service n’est pas administrateur national et que l’intervenant ne correspond pas à celui du contact, un message d’erreur est émis par la PHyC.

Un gestionnaire de zone hydrologique avec un profil institutionnel (001), n’a pas le droit de retirer le profil modélisateur à un contact cible ayant un profil institutionnel+modélisateur (011). Le même gestionnaire de zone pourra retirer son profil institutionnel à un contact cible ayant seulement un profil institutionnel (001).

Si le contact cible est un administrateur national, il n’est pas possible de modifier son profil.

Seul un administrateur national peut modifier le profil d’un administrateur national.

Seul un administrateur national peut attribuer le profil d’administrateur national.

Contenu de la requête HTTP¶

La requête HTTP doit contenir un json hydrométrie contenant le contact à modifier.

Json hydrométrie¶

Schéma de validation d’ajout de contact¶

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://phyc.org/ws/ajouterContact.json",
  "type": "object",
  "properties": {
    "Scenario": {
      "type": "object"
    },
    "RefHyd": {
      "type": "object",
      "properties": {
        "Intervenants": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "CdIntervenant": {"type": "string"},
              "schemeAgencyID": {
                "type": "string",
                "enum": ["SANDRE", "SIRET"]
              },
              "Contacts": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "CdContact": {"type":  "string"},
                    "NomContact": {"type":  "string"},
                    "PrenomContact": {"type":  "string"},
                    "CiviliteContact": {"type":  "integer", "enum":  [1, 2, 3]},
                    "ProfilContact": {"type":  "string", "enum":  ["000", "001", "011", "111"]},
                    "AdContact": {"type":  ["string", "null"]},
                    "AdEtrangereContact": {"type":  ["string", "null"]},
                    "CpContact": {"type":  ["string", "null"]},
                    "VilleContact": {"type":  ["string", "null"]},
                    "FonctionContact": {"type":  ["string", "null"]},
                    "TelephoneContact": {"type":  ["string", "null"]},
                    "PortContact": {"type":  ["string", "null"]},
                    "FaxContact": {"type":  ["string", "null"]},
                    "MelContact": {"type":  "string"},
                    "PaysContact": {"type":  ["string", "null"]},
                    "AliasContact": {"type":  ["string", "null"]},
                    "DtDesactivationContact": {"type":  ["string", "null"], "format": "date-time"}
                  },
                  "required": ["CdContact"],
                  "additionalProperties": false
                },
                "minItems": 1
              }
            },
            "required": ["CdIntervenant"],
            "additionalProperties": false
          },
          "minItems": 1,
          "maxItems": 1
        }
      },
      "required": ["Intervenants"],
      "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 Intervenants associé à une liste ne contenant qu’un seul objet Intervenant;
L’objet Intervenant doit contenir les attributs CdIntervenant et Contacts;
L’attribut Contacts doit être une liste non vide d’objets Contact;
L’objet Contact ne doit pas contenir les attributs DateMAJContact, ProfilsAdminLocal, MotPassContact, et DtActivationContact.

L’attribut DtDesactivationContact permet de désactiver ou d’activer un contact.

Un contact désactivé ne pourra plus utiliser les webservices de la PHyC.

Les données provenant d’un contact désactivé ne seront plus être modifiées.

Réponse du web-service¶

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

Le web-service rajoutera l’attribut DateMajContact : date de mise à jour du contact.