Différences entre versions de « WebAPI Client.GetClients »

Version du 2 octobre 2017 à 12:03

Cette fonctionnalité n'est plus 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.

Methode Client.GetClients

Appel Web : http://xx.xx.xx.xx/core/api/Client.GetClients

InfoClient[] Client.GetClients (<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> ChampsDeRecherche, <a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32'>Int32</a> CodeMagasin, [xml|json output = xml ])

Rechercher client

Arguments :

Nom	Type	Description
ChampsDeRecherche	<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a>	Le champ de recherche est limité à 256 charactères et support : La recherche par Nom, Prenon et/ou Code Postal dans n'importe quel ordre (exp : Jean pierre 33) La recherche par E-mail (exp : vega@info.fr) La recherche par code barres (exp : 2900040000016)
CodeMagasin	<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32'>Int32</a>	Code magasin de référence de la validité des cartes de fidélités
output	xml\|json	(optionnel, par défaut: xml) Format de la réponse
Retour	InfoClient[]	InfoClient[]

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»

@@ Ligne 1 : / Ligne 1 : @@
-{{DebutInfoCartographe}}{{FinInfoCartographe}}
+{{DebutInfoCartographe}}{{Jusqua|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 : [[NF13075|Interface de programmation applicative par Webservice (API)]].
+<div id='api-body'><p class='prp'>L'API client permet de gérer la création, modification et la recherche de clients.</p><h2>Methode Client.GetClients</h2><p class='appel'><span class='lbl'>Appel Web&nbsp;:</span> <span class='vlr'>http://xx.xx.xx.xx/core/api/Client.GetClients</span></p><p class='signature'><span class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Client+InfoClient|InfoClient]][]</span> <span class='method-name'>Client.GetClients</span><span class='parameters'>&nbsp;(<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></span> <span class='parameter-name'>ChampsDeRecherche</span>, <span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32'>Int32</a></span> <span class='parameter-name'>CodeMagasin</span>, <span class='opt'>[<span class='parameter-type'>xml|json</span> <span class='parameter-name'>output</span> = xml ]</span>)</span></p><p class='mrp'>Rechercher client</p><div class='args'><p><span class='lbl'>Arguments&nbsp;:</span></p><table class='t-args'><tr><thead><th>Nom</th><th>Type</th><th>Description</th></thead></tr><tr><th class='parameter-name'>ChampsDeRecherche</th><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></td><td class='parameter-txt'><span class='param-doc'>
+Le champ de recherche est limité à 256 charactères et support :<br/>
+    La recherche par Nom, Prenon et/ou Code Postal dans n'importe quel ordre (exp : Jean pierre 33)<br/>
+    La recherche par E-mail (exp : vega@info.fr)<br/>
+    La recherche par code barres (exp : 2900040000016)
+                        </span></td></tr><tr><th class='parameter-name'>CodeMagasin</th><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32'>Int32</a></td><td class='parameter-txt'><span class='param-doc'>Code magasin de référence de la validité des cartes de fidélités</span></td></tr><tr><th class='parameter-name'>output</th><td class='parameter-type'>xml|json</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: xml)<br/></span><span class='param-doc'>Format de la réponse</span></td></tr><tr class='t-return'><th>Retour</th><td class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Client+InfoClient|InfoClient]][]</td><td class='return-doc'>InfoClient[]</td></tr></table><p><span class='lbl'>Politique de sécurité et règles d'accès à l'API&nbsp;:</span></p><p style='padding-left:1em;'>au moins une des conditions suivantes doit être vérifiée&nbsp;: <ul><li>Posséder le droit «<span class='security-elt'>consultation des membres clients</span>»</li><li>Posséder le droit «<span class='security-elt'>saisie des membres clients</span>»</li></ul></p></div></div>
+{{FinInfoCartographe}}[[Catégorie:Webservice API|Client.GetClients]]