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

Version du 5 mai 2021 à 16:31

Disponible depuis la version 7.04

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://90.120.47.21/core/api/Client.GetClientsModified

FragmentedInfoClient Client.GetClientsModified (DateTime lastChanged, Int32 codeMagasin, [String checkPoint = null], [String prefixCle = null], [Int32 limit = 100], [xml|json output = xml ])

Retourne les informations des clients ayant été modifiés ou présentant un changement depuis une date précise, trié par ordre de changement, des plus vieux au plus récent.

           Cette méthode vous permet de boucler sur une demande des clients par tranche de 100 pour éviter de trop consommer de ressources mémoire :

demande des 100 premiers clients depuis le X
tant que hasMoreResults == vrai, alors rappeler avec mêmes arguments en précisant le point de reprise (checkpoint) communiqué dans la dernière réponse

Arguments :

Nom	Type	Description
lastChanged	DateTime	Date de dernière modification
codeMagasin	Int32	Code magasin de référence de la validité des cartes de fidélité
checkPoint	String	(optionnel, par défaut: null) checkPoint si existant et connu
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 !
limit	Int32	(optionnel, par défaut: 100) Renvoyer que les X premiers éléments
output	xml\|json	(optionnel, par défaut: xml) Format de la réponse
Retour	FragmentedInfoClient	Information client

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 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'>http://localhost/core/api/Client.GetClientsModified</span></p><p class='signature'><span class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Client+FragmentedInfoClient|FragmentedInfoClient]]</span> <span class='method-name'>Client.GetClientsModified</span><span class='parameters'>&nbsp;(<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.DateTime DateTime]</span> <span class='parameter-name'>lastChanged</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'>checkPoint</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'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32 Int32]</span> <span class='parameter-name'>limit</span> = 100]</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 des clients ayant été modifiés ou présentant un changement depuis une date précise, trié par ordre de changement, des plus vieux au plus récent.
+<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'>http://90.120.47.21/core/api/Client.GetClientsModified</span></p><p class='signature'><span class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Client+FragmentedInfoClient|FragmentedInfoClient]]</span> <span class='method-name'>Client.GetClientsModified</span><span class='parameters'>&nbsp;(<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.DateTime DateTime]</span> <span class='parameter-name'>lastChanged</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'>checkPoint</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'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32 Int32]</span> <span class='parameter-name'>limit</span> = 100]</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 des clients ayant été modifiés ou présentant un changement depuis une date précise, trié par ordre de changement, des plus vieux au plus récent.
              Cette méthode vous permet de boucler sur une demande des clients par tranche de 100 pour éviter de trop consommer de ressources mémoire :
              <ol><li>demande des 100 premiers clients depuis le X</li>
              <li>tant que hasMoreResults == vrai, alors rappeler avec mêmes arguments en précisant le point de reprise (checkpoint) communiqué dans la dernière réponse</li></ol></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'>lastChanged</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.DateTime DateTime]</td><td class='parameter-txt'><span class='param-doc'>Date de dernière modification</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é</span></td></tr><tr><th class='parameter-name'>checkPoint</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'>checkPoint si existant et connu</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'>limit</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32 Int32]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: 100)<br/></span><span class='param-doc'>Renvoyer que les X premiers éléments</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+FragmentedInfoClient|FragmentedInfoClient]]</td><td class='return-doc'>Information client</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|GetClientsModified]]