Différences entre versions de « WebAPI Type RepDaemon.WebService2.CoreAPI.Client+InfoClient »

De Documentation Polaris
Aller à : navigation, rechercher
(Modification automatique par le cartographe)
(Modification automatique par le cartographe)
 
(8 versions intermédiaires par le même utilisateur non affichées)
Ligne 1 : Ligne 1 :
{{DebutInfoCartographe}}{{Jusqua|6.02}}
+
{{DebutInfoCartographe}}{{Depuis|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é.
 
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 : [[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'><div class='args'><h2>Type RepDaemon.WebService2.CoreAPI.Client+InfoClient</h2><p>Code client<br/></p><table class='t-args'><thead><tr><th>Nom</th><th>Type</th><th>Description</th></tr></thead><tr><td class='parameter-name'>IDClient</td><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int64'>Int64 (Optionnel)</a></td><td class='parameter-txt'>Code client</td></tr><tr><td class='parameter-name'>Email</td><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></td><td class='parameter-txt'>Email (255 caractères maximum)</td></tr><tr><td class='parameter-name'>Idem</td><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></td><td class='parameter-txt'>Civilité (4 caractères maximum)</td></tr><tr><td class='parameter-name'>Prenom</td><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></td><td class='parameter-txt'>Prénom (64 caractères maximum)</td></tr><tr><td class='parameter-name'>Nom</td><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></td><td class='parameter-txt'>Nom (64 caractères maximum)</td></tr><tr><td class='parameter-name'>Adresse1</td><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></td><td class='parameter-txt'>Adresse 1 (38 caractères maximum)</td></tr><tr><td class='parameter-name'>Adresse2</td><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></td><td class='parameter-txt'>Adresse 2 (38 caractères maximum)</td></tr><tr><td class='parameter-name'>Adresse3</td><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></td><td class='parameter-txt'>Adresse 3 (38 caractères maximum)</td></tr><tr><td class='parameter-name'>CodePostal</td><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></td><td class='parameter-txt'>Code postal (8 caractères maximum)</td></tr><tr><td class='parameter-name'>Ville</td><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></td><td class='parameter-txt'>Ville (26 caractères maximum)</td></tr><tr><td class='parameter-name'>Pays</td><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></td><td class='parameter-txt'>Pays (si ce champs est vide l'adresse sera française par défaut)<br/>
+
<div id='api-body'><div class='args'><br/><p>Code client<br/></p><table class='t-args'><tr><th>Nom</th><th>Type</th><th>Description</th></tr><tr><td class='parameter-name'>IDClient</td><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int64 Int64 (Optionnel)]</td><td class='parameter-txt'>Code client</td></tr><tr><td class='parameter-name'>Email</td><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'>Email (255 caractères maximum)</td></tr><tr><td class='parameter-name'>Cles</td><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String][]</td><td class='parameter-txt'>Vos références pour ce client (optionnel, 128 caractères max) utilisées pour les recherches quand le mail est inconnu ou à changé entre deux appels. Il peut éventuellement y avoir plusieurs références si nous avons procédé à la fusion de deux clients en un.</td></tr><tr><td class='parameter-name'>Idem</td><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'>Civilité (4 caractères maximum)</td></tr><tr><td class='parameter-name'>Prenom</td><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'>Prénom (64 caractères maximum)</td></tr><tr><td class='parameter-name'>Nom</td><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'>Nom (64 caractères maximum)</td></tr><tr><td class='parameter-name'>Adresse1</td><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'>Adresse 1 (38 caractères maximum)</td></tr><tr><td class='parameter-name'>Adresse2</td><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'>Adresse 2 (38 caractères maximum)</td></tr><tr><td class='parameter-name'>Adresse3</td><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'>Adresse 3 (38 caractères maximum)</td></tr><tr><td class='parameter-name'>CodePostal</td><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'>Code postal (8 caractères maximum)</td></tr><tr><td class='parameter-name'>Ville</td><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'>Ville (26 caractères maximum)</td></tr><tr><td class='parameter-name'>Pays</td><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'>Pays (si ce champs est vide l'adresse sera française par défaut)<br/>
Exemple : "france", "belgique", "canada, québec" .. etc</td></tr><tr><td class='parameter-name'>Tel</td><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></td><td class='parameter-txt'>Téléphone (20 caractères maximum)</td></tr><tr><td class='parameter-name'>DateDeNaissance</td><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.DateTime'>DateTime (Optionnel)</a></td><td class='parameter-txt'>Date de naissance</td></tr><tr><td class='parameter-name'>Carte</td><td class='parameter-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Client+Carte|Carte]][]</td><td class='parameter-txt'>Carte de fidélité</td></tr><tr><td class='parameter-name'>Segment</td><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></td><td class='parameter-txt'>Segment (Ne peux être définie par un PUT, toujours vide))</td></tr><tr><td class='parameter-name'>Avantages</td><td class='parameter-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Client+Bon|Bon]][]</td><td class='parameter-txt'>Avantages (les bons en cours de validité pour ce client, Ne peux être définie par un PUT)</td></tr><tr><td class='parameter-name'>Optin</td><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean'>Boolean</a></td><td class='parameter-txt'>Optin (Ne peux être définie par un PUT, toujours égale à false)</td></tr></table></div></div>
+
Exemple : "france", "belgique", "canada, québec" .. etc</td></tr><tr><td class='parameter-name'>Memo</td><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'>Obtient le mémo lié au client, ou définit dans le cas de Put si le mémo n'est pas nul</td></tr><tr><td class='parameter-name'>Tel</td><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'>Téléphone (20 caractères maximum)</td></tr><tr><td class='parameter-name'>DateDeNaissance</td><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.DateTime DateTime (Optionnel)]</td><td class='parameter-txt'>Date de naissance</td></tr><tr><td class='parameter-name'>Carte</td><td class='parameter-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Client+Carte|Carte]][]</td><td class='parameter-txt'>Carte de fidélité</td></tr><tr><td class='parameter-name'>Segment</td><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'>Segment (Ne peut être défini par un PUT, toujours vide))</td></tr><tr><td class='parameter-name'>Avantages</td><td class='parameter-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Client+Bon|Bon]][]</td><td class='parameter-txt'>Avantages : bons en cours de validité pour ce client. Si un bon disparait de cette liste, c'est qu'il a été utilisé ou invalidé (ne peut pas être défini par une méthode d'écriture)</td></tr><tr><td class='parameter-name'>Optin</td><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean (Optionnel)]</td><td class='parameter-txt'>Optin (La liste de diffusion d'envoye par e-mail est utilisé pour cette options)</td></tr><tr><td class='parameter-name'>AddToListesDiffusion</td><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int64 Int64][]</td><td class='parameter-txt'>Listes de diffusion dans lequel ce client doit apparaître</td></tr><tr><td class='parameter-name'>RemoveFromListesDiffusion</td><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int64 Int64][]</td><td class='parameter-txt'>Listes de diffusion desquelles ce client doit disparaître, spécifiez un élément avec le numéro 0 pour retirer le client de toutes les listes de diffusions</td></tr><tr><td class='parameter-name'>DateDerniereModification</td><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.DateTime DateTime]</td><td class='parameter-txt'>Date de dernière modification du client</td></tr><tr><td class='parameter-name'>CodeMagasin</td><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32 Int32]</td><td class='parameter-txt'>Code du magasin de rattachement du client (en lecture seule)</td></tr><tr><td class='parameter-name'>Quarantaine</td><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean]</td><td class='parameter-txt'>Client en cours de suppression (lecture uniquement)</td></tr></table></div></div>
{{FinInfoCartographe}}[[Catégorie:Webservice API|Type RepDaemon.WebService2.CoreAPI.Client+InfoClient]]
+
{{FinInfoCartographe}}[[Catégorie:Webservice types|RepDaemon.WebService2.CoreAPI.Client+InfoClient]]

Version actuelle datée du 15 septembre 2020 à 10:36

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


Code client

NomTypeDescription
IDClientInt64 (Optionnel)Code client
EmailStringEmail (255 caractères maximum)
ClesString[]Vos références pour ce client (optionnel, 128 caractères max) utilisées pour les recherches quand le mail est inconnu ou à changé entre deux appels. Il peut éventuellement y avoir plusieurs références si nous avons procédé à la fusion de deux clients en un.
IdemStringCivilité (4 caractères maximum)
PrenomStringPrénom (64 caractères maximum)
NomStringNom (64 caractères maximum)
Adresse1StringAdresse 1 (38 caractères maximum)
Adresse2StringAdresse 2 (38 caractères maximum)
Adresse3StringAdresse 3 (38 caractères maximum)
CodePostalStringCode postal (8 caractères maximum)
VilleStringVille (26 caractères maximum)
PaysStringPays (si ce champs est vide l'adresse sera française par défaut)
Exemple : "france", "belgique", "canada, québec" .. etc
MemoStringObtient le mémo lié au client, ou définit dans le cas de Put si le mémo n'est pas nul
TelStringTéléphone (20 caractères maximum)
DateDeNaissanceDateTime (Optionnel)Date de naissance
CarteCarte[]Carte de fidélité
SegmentStringSegment (Ne peut être défini par un PUT, toujours vide))
AvantagesBon[]Avantages : bons en cours de validité pour ce client. Si un bon disparait de cette liste, c'est qu'il a été utilisé ou invalidé (ne peut pas être défini par une méthode d'écriture)
OptinBoolean (Optionnel)Optin (La liste de diffusion d'envoye par e-mail est utilisé pour cette options)
AddToListesDiffusionInt64[]Listes de diffusion dans lequel ce client doit apparaître
RemoveFromListesDiffusionInt64[]Listes de diffusion desquelles ce client doit disparaître, spécifiez un élément avec le numéro 0 pour retirer le client de toutes les listes de diffusions
DateDerniereModificationDateTimeDate de dernière modification du client
CodeMagasinInt32Code du magasin de rattachement du client (en lecture seule)
QuarantaineBooleanClient en cours de suppression (lecture uniquement)