Différences entre versions de « WebAPI Catalog.SearchProducts »

Version du 30 juillet 2018 à 17:49

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 Catalog permet d'interroger le système d'information sur les données publiques et le catalogue des produits gérés et proposés à la vente

Appel Web : http://localhost/core/api/Catalog.SearchProducts

ProductsFound Catalog.SearchProducts ([UInt64 noSite = 0], [String filtreSousFamille = null], [String filtreFamille = null], [String filtreRayon = null], [String filtreMarque = null], [String searchTxt = null], [Boolean onlyInternet = False], [xml|json output = xml ])

Recherche de produits

Arguments :

Nom	Type	Description
noSite	UInt64	(optionnel, par défaut: 0) Numéro de site internet pour lequel nous tirons les données. Indiquer 0 pour tirer les informations de base, en dehors de toute considération de données de site Internet.
filtreSousFamille	String	(optionnel, par défaut: null) Filtre de sous-familles dans lesquelles effectuer la recherche (numéros internes séparés par des virgules)
filtreFamille	String	(optionnel, par défaut: null) Filtre de familles dans lesquelles effectuer la recherche (numéros internes séparés par des virgules)
filtreRayon	String	(optionnel, par défaut: null) Filtre de rayons dans lesquels effectuer la recherche (numéros internes séparés par des virgules)
filtreMarque	String	(optionnel, par défaut: null) Filtre de marque dans lesquelles effectuer la recherche (numéros internes séparés par des virgules)
searchTxt	String	(optionnel, par défaut: null) Recherche
onlyInternet	Boolean	(optionnel, par défaut: False) Modèles publiés sur Internet uniquement
output	xml\|json	(optionnel, par défaut: xml) Format de la réponse
Retour	ProductsFound	Non documenté

Politique de sécurité et règles d'accès à l'API :

au moins une des conditions suivantes doit être vérifiée :

être identifié
passer par un lien de type boucle locale
passer par un lien de type machine
passer par un lien de type lien local

@@ 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 Catalog permet d'interroger le système d'information sur les données publiques et le catalogue des produits gérés et proposés à la vente</p>
+<div id='api-body'><p class='prp'>L'API Catalog permet d'interroger le système d'information sur les données publiques et le catalogue des produits gérés et proposés à la vente</p><br/><p class='appel'><span class='lbl'>Appel Web&nbsp;:</span> <span class='vlr'>http://localhost/core/api/Catalog.SearchProducts</span></p><p class='signature'><span class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Catalog+ProductsFound|ProductsFound]]</span> <span class='method-name'>Catalog.SearchProducts</span><span class='parameters'>&nbsp;(<span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.UInt64 UInt64]</span> <span class='parameter-name'>noSite</span> = 0]</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'>filtreSousFamille</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'>filtreFamille</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'>filtreRayon</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'>filtreMarque</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'>searchTxt</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean]</span> <span class='parameter-name'>onlyInternet</span> = False]</span>, <span class='opt'>[<span class='parameter-type'>xml|json</span> <span class='parameter-name'>output</span> = xml ]</span>)</span></p><p class='mrp'>Recherche de produits</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'>noSite</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.UInt64 UInt64]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: 0)<br/></span><span class='param-doc'>Numéro de site internet pour lequel nous tirons les données. Indiquer 0 pour tirer les informations de base, en dehors de toute considération de données de site Internet.</span></td></tr><tr><th class='parameter-name'>filtreSousFamille</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'>Filtre de sous-familles dans lesquelles effectuer la recherche (numéros internes séparés par des virgules)</span></td></tr><tr><th class='parameter-name'>filtreFamille</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'>Filtre de familles dans lesquelles effectuer la recherche (numéros internes séparés par des virgules)</span></td></tr><tr><th class='parameter-name'>filtreRayon</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'>Filtre de rayons dans lesquels effectuer la recherche (numéros internes séparés par des virgules)</span></td></tr><tr><th class='parameter-name'>filtreMarque</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'>Filtre de marque dans lesquelles effectuer la recherche (numéros internes séparés par des virgules)</span></td></tr><tr><th class='parameter-name'>searchTxt</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'>Recherche</span></td></tr><tr><th class='parameter-name'>onlyInternet</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: False)<br/></span><span class='param-doc'>Modèles publiés sur Internet uniquement</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.Catalog+ProductsFound|ProductsFound]]</td><td class='return-doc'>Non documenté</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>être identifié</li><li>passer par un lien de type <span class='security-elt'>boucle locale</span></li><li>passer par un lien de type <span class='security-elt'>machine</span></li><li>passer par un lien de type <span class='security-elt'>lien local</span></li></ul></p></div></div>
-== Methode Catalog.SearchProducts ==
-<p class='appel'><span class='lbl'>Appel Web&nbsp;:</span> <span class='vlr'>http://localhost/core/api/Catalog.SearchProducts</span></p><p class='signature'><span class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Catalog+ProductsFound|ProductsFound]]</span> <span class='method-name'>Catalog.SearchProducts</span><span class='parameters'>&nbsp;(<span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.UInt64 UInt64]</span> <span class='parameter-name'>noSite</span> = 0]</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'>filtreSousFamille</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'>filtreFamille</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'>filtreRayon</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'>filtreMarque</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'>searchTxt</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean]</span> <span class='parameter-name'>onlyInternet</span> = False]</span>, <span class='opt'>[<span class='parameter-type'>xml|json</span> <span class='parameter-name'>output</span> = xml ]</span>)</span></p><p class='mrp'>Recherche de produits</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'>noSite</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.UInt64 UInt64]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: 0)<br/></span><span class='param-doc'>Numéro de site internet pour lequel nous tirons les données. Indiquer 0 pour tirer les informations de base, en dehors de toute considération de données de site Internet.</span></td></tr><tr><th class='parameter-name'>filtreSousFamille</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'>Filtre de sous-familles dans lesquelles effectuer la recherche (numéros internes séparés par des virgules)</span></td></tr><tr><th class='parameter-name'>filtreFamille</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'>Filtre de familles dans lesquelles effectuer la recherche (numéros internes séparés par des virgules)</span></td></tr><tr><th class='parameter-name'>filtreRayon</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'>Filtre de rayons dans lesquels effectuer la recherche (numéros internes séparés par des virgules)</span></td></tr><tr><th class='parameter-name'>filtreMarque</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'>Filtre de marque dans lesquelles effectuer la recherche (numéros internes séparés par des virgules)</span></td></tr><tr><th class='parameter-name'>searchTxt</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'>Recherche</span></td></tr><tr><th class='parameter-name'>onlyInternet</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: False)<br/></span><span class='param-doc'>Modèles publiés sur Internet uniquement</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.Catalog+ProductsFound|ProductsFound]]</td><td class='return-doc'>Non documenté</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>être identifié</li><li>passer par un lien de type <span class='security-elt'>boucle locale</span></li><li>passer par un lien de type <span class='security-elt'>machine</span></li><li>passer par un lien de type <span class='security-elt'>lien local</span></li></ul></p></div></div>
 {{FinInfoCartographe}}
 [[Catégorie:Webservice Catalog|SearchProducts]]