Fonction Clients

Ajout / Modification / Suppression d’un nouveau Client

Fonction Variables Types Commentaires
setFicheClient keyAccount string(32) Représente la clé du compte client.
token string(32) Token renvoyé par la fonction getToken().
codeClient string(32) Représente l'identifiant unique du client au sein du logiciel métier.
action string(1) 'I' pour un ajout, 'U' pour une modification, 'D' pour supprimer.
jsonField string Tableau au format json des données du client à créer.

Valeur de retour

Retourne 0 si la création s’est bien effectuée.
Sinon renvoi une chaîne au format json contenant la cause de l’échec de la création. Cf. Structure json message d'erreur



Tableau des valeurs pour un Client (TLP signifie TéléPointage)

Noms Types Obligatoire Commentaires
TLP_code_client varchar(32) O identifiant unique du client/bénéficiaire dans le logiciel métier
TLP_statut int(1) N 0=prospect, 1=client
TLP_etat int(1) N 0=inactif, 1=actif
TLP_raison_sociale varchar(32) N
TLP_nom varchar(32) O
TLP_prenom varchar(32) O
TLP_adresse varchar(100) O
TLP_cp varchar(5) O
TLP_ville varchar(32) O
TLP_tel varchar(15) O
TLP_email varchar(50) N
TLP_code_secteur varchar(10) N Est le code secteur de rattachement du client
TLP_lati varchar(20) N Si non renseigné Badgelio le déterminera automatiquement.
TLP_longi varchar(20) N Si non renseigné Badgelio le déterminera automatiquement.
TLP_site int(2) N
TLP_distanceAutoriser int(11) N Distance de vérification du pointage.
TLP_modeQR int(1) N Autoriser le pointage hors zone de validation.
TLP_CPHZ int(1) N
TLP_numeros_autoriser tinytext N Liste de numéros fixe séparée par des ';' autorisant le pointage par numéro.
TLP_validation_code int(4) N Code PIN à 4 chiffres pour la validation de la prestation par le bénéficiaire.

Exemple en PHP


$jsonField = 
'{
  "TLP_code_client":"12345",
  "TLP_nom":"DOE",
  "TLP_prenom":"John",
  "TLP_cp":"77600",
  "TLP_adresse":"164 av victor hugo"
}';

$codeClient = "12345";
$action = "U";
$res = $objSoap->setFicheClient($keyAccount, $token, $codeClient, $action, $jsonField);

Récupération d’informations de la Fiche Client

Fonction Variables Types Commentaires
getFicheClient keyAccount string(32) Représente la clé du compte client.
token string(32) Token renvoyé par la fonction getToken().
codeClient string(32) Représente l'identifiant unique du client au sein du logiciel métier.
jsonField string Tableau au format json des données du client à créer.

La liste des variables pouvant être renvoyée se trouve dans le tableau des valeurs clients, et auquel il faut ajouter les variables:

Noms Types Obligatoire Commentaires
TLP_qrcode tinytext N Clé unique contenu dans le QR code.
TLP_tsp datetime N Timestamp de dernière modification.