WebAPI Client.GetClientsModified

De Documentation Polaris
Révision datée du 5 mai 2021 à 16:31 par R2d2 (discussion | contributions) (Modification automatique par le cartographe)

Aller à : navigation, rechercher
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 :
  1. demande des 100 premiers clients depuis le X
  2. 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 :

NomTypeDescription
lastChangedDateTimeDate de dernière modification
codeMagasinInt32Code magasin de référence de la validité des cartes de fidélité
checkPointString (optionnel, par défaut: null)
checkPoint si existant et connu
prefixCleString (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 !
limitInt32 (optionnel, par défaut: 100)
Renvoyer que les X premiers éléments
outputxml|json (optionnel, par défaut: xml)
Format de la réponse
RetourFragmentedInfoClientInformation 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»