Différences entre versions de « WebAPI Client.GetClient »
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'>http://localhost/core/api/Client.GetClient</span></p><p class='signature'><span class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Client+InfoClient|InfoClient]]</span> <span class='method-name'>Client.GetClient</span><span class='parameters'> (<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int64 Int64]</span> <span class='parameter-name'>IDClient</span>, <span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System. | + | <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'>http://localhost/core/api/Client.GetClient</span></p><p class='signature'><span class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Client+InfoClient|InfoClient]]</span> <span class='method-name'>Client.GetClient</span><span class='parameters'> (<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.Int64 Int64 (Optionnel)]</span> <span class='parameter-name'>IDClient</span> = null]</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'>Cle</span> = null]</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'>Retourne les informations d'un 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'>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'>IDClient</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int64 Int64 (Optionnel)]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Numéro du client</span></td></tr><tr><th class='parameter-name'>Cle</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'>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</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 :</span></p><p style='padding-left:1em;'>au moins une des conditions suivantes doit être vérifiée : <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|GetClient]] | {{FinInfoCartographe}}[[Catégorie:Webservice Client|GetClient]] | ||
Version du 25 février 2019 à 11:03
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 :
| Nom | Type | Description |
|---|---|---|
| CodeMagasin | Int32 | Code magasin de référence de la validité des cartes de fidélités |
| IDClient | Int64 (Optionnel) | (optionnel, par défaut: null) Numéro du client |
| Cle | String | (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 |
| 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»