API : Ajout de propriétés spécifiques au Client

Sur un client, il est possible d’ajouter des champs (propriétés) libres associés à votre métier.
La description des champs libres devra au préalable avoir été définie avec le support SELL&SIGN (Définition de la clef) pour l’incorporer dans votre schéma client.

Avec votre numéro de client unique, vous pouvez récupérer ou affecter des valeurs sur des champs libres.

  1. Retrouver des propriétés spécifiques d’un client.
  2. Créer ou modifier la valeur d’un champ libre Client

Retrouver les propriétés d’un client

Cette url permet d’obtenir une liste de toutes les propriétés d’un client spécifié par son numéro unique.

https://[host]/calinda/hub/selling/model/customerproperty/list?action=getCustomerPropertyListFor&[paramètres]

Paramètres obligatoires :

Exemple :

https://cloud.sellandsign.com/calinda/hub/selling/model/customerproperty/list?action=getCustomerPropertyListFor&number=Mi4xNDg4MTkxMjM2NjAwLjk1Nzg0

Retour :

{
"id": 225881,
"key": "adresse_bien",
"value": "Quai Rive Neuve",
"customerNumber": "Mi4xNDg4MTkxMjM2NjAwLjk1Nzg0",
..
},
{
"id": 225882,
"key": "cp_bien",
"value": "13560",
"customerNumber": "Mi4xNDg4MTkxMjM2NjAwLjk1Nzg0",
..
},
{
"id": 225883,
"key": "ville_bien",
"value": "SENAS",
"customerNumber": "Mi4xNDg4MTkxMjM2NjAwLjk1Nzg0"
..
}

id : correspond à la référence unique de la propriété (clef)
key : clef du champ spécifique
value : sa valeur
customerNumber : référence du client

Créer ou modifier une propriété spécifique d’un Client

La même méthode permet de créer ou de mettre à jour les champs d’une propriété spécifique. Si l’identifiant de la propriété est spécifié alors la propriété sera mise à jour. Si cet identifiant est égal à -1, alors la propriété est créée et rattachée au client spécifié.

https://[host]/calinda/hub/selling/model/customerproperty/update?action=getOrCreateCustomerProperty&[paramètres]

Paramètres obligatoires :

  • customer_number : numéro de client (voir création du client)
  • key : code de la propriété spécifique
  • value : valeur de la clé
  • id : pour une création spécifier -1 / pour une mise à jour, spécifier l’identifiant de la propriété (un entier long)

Exemple :
Modification de la valeur de la propriété ‘ville_bien’

https://cloud.sellandsign.com/calinda/hub/selling/model/customerproperty/update?action=getOrCreateCustomerProperty&customer_number=Mi4xNDkxOTIxMDAwNDI1LjY0ODM3&key=ville_bien&value=LA%20BAS&id=225887

Retour :

{
"id": 225887,
"key": "ville_bien",
"value": "LA BAS",
"customerNumber": "Mi4xNDkxOTIxMDAwNDI1LjY0ODM3",
"syncTimer": 1495784112126,
"lastModificationPlace": "SERVER"
}