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

Version actuelle datée du 26 janvier 2024 à 10:31

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).

@@ Ligne 4 : / Ligne 4 : @@
 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><br/><p class='appel'><span class='lbl'>Appel Web&nbsp;:</span> <span class='vlr'>https://nur298.ws-dev.polarisgestionmag.net/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'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</span> <span class='parameter-name'>ChampsDeRecherche</span>, <span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32 Int32]</span> <span class='parameter-name'>CodeMagasin</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</span> <span class='parameter-name'>prefixCle</span> = null]</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><th>Nom</th><th>Type</th><th>Description</th></tr><tr><th class='parameter-name'>ChampsDeRecherche</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'><span class='param-doc'>
-Le champ de recherche est limité à 256 charactères et supporte :<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'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32 Int32]</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'>prefixCle</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>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 ! </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 Client|GetClients]]