Différences entre versions de « WebAPI Client.GetClients »
De Documentation Polaris
(Modification automatique par le cartographe) |
(Modification automatique par le cartographe) |
||
| 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)]]. | 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 :</span> <span class='vlr'> | + | <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 :</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'> (<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 :</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/> | 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 Nom, Prenon et/ou Code Postal dans n'importe quel ordre (exp : Jean pierre 33)<br/> | ||
Version du 18 juillet 2022 à 10:23
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 : https://nur298.ws-dev.polarisgestionmag.net/core/api/Client.GetClients
InfoClient[] Client.GetClients (String ChampsDeRecherche, Int32 CodeMagasin, [String prefixCle = null], [xml|json output = xml ])
Rechercher client
Arguments :
| Nom | Type | Description |
|---|---|---|
| ChampsDeRecherche | String |
Le champ de recherche est limité à 256 charactères et supporte : la recherche par Nom, Prenon et/ou Code Postal dans n'importe quel ordre (exp : Jean pierre 33) |
| CodeMagasin | Int32 | Code magasin de référence de la validité des cartes de fidélités |
| prefixCle | String | (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 ! |
| 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»