WebAPI Client.GetClient

De Documentation Polaris
Révision datée du 25 février 2019 à 11:03 par R2d2 (discussion | contributions) (Modification automatique par le cartographe)

Aller à : navigation, rechercher
Disponible depuis la version 6.02

L'API par Webservice vous permet de piloter ou d'interroger votre solution de gestion depuis un programme externe via un langage normalisé. Pour obtenir plus d'informations sur la bibliothèque d'APIs, consultez la page de documentation suivante : Interface de programmation applicative par Webservice (API).

L'API client permet de gérer la création, modification et la recherche de clients.


Appel Web : http://localhost/core/api/Client.GetClient

InfoClient Client.GetClient (Int32 CodeMagasin, [Int64 (Optionnel) IDClient = null], [String Cle = null], [String prefixCle = null], [xml|json output = xml ])

Retourne les informations d'un client

Arguments :

NomTypeDescription
CodeMagasinInt32Code magasin de référence de la validité des cartes de fidélités
IDClientInt64 (Optionnel) (optionnel, par défaut: null)
Numéro du client
CleString (optionnel, par défaut: null)
Si vous ne connaissez pas le IDClient, Clé extérieure : votre référence client si vous nous les communiquez à travers d'un préfixe de recherche
prefixCleString (optionnel, par défaut: null)
Préfixe pour la clé extérieure. Le préfixe à utiliser vous est communiqué par VEGA Informatique sur demande et vous devez le préciser systématiquement si vous utilisez les clés extérieures !
outputxml|json (optionnel, par défaut: xml)
Format de la réponse
RetourInfoClientInfoClient

Politique de sécurité et règles d'accès à l'API :

au moins une des conditions suivantes doit être vérifiée :

  • Posséder le droit «consultation des membres clients»
  • Posséder le droit «saisie des membres clients»