Différences entre versions de « WebAPI SiliconSalad.GetVouchers »
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 SiliconSalad permet de gérer la consultation et les mouvements de stocks par les site SiliconSalad.</p><br/><p class='appel'><span class='lbl'>Appel Web :</span> <span class='vlr'> | + | <div id='api-body'><p class='prp'>L'API SiliconSalad permet de gérer la consultation et les mouvements de stocks par les site SiliconSalad.</p><br/><p class='appel'><span class='lbl'>Appel Web :</span> <span class='vlr'>https://nur298.ws-dev.polarisgestionmag.net/core/api/SiliconSalad.GetVouchers</span></p><p class='signature'><span class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.SiliconSalad+VoucherInfo|VoucherInfo]][]</span> <span class='method-name'>SiliconSalad.GetVouchers</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.DateTime DateTime (Optionnel)]</span> <span class='parameter-name'>lastDate</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.SiliconSalad+CustomerMultiId|CustomerMultiId]][]</span> <span class='parameter-name'>customers</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> = 50000]</span>, <span class='opt'>[<span class='parameter-type'>xml|json</span> <span class='parameter-name'>output</span> = xml ]</span>)</span></p><p class='mrp'>Obtient la liste des bons du système, par ordre de modification</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 bons</span></td></tr><tr><th class='parameter-name'>lastDate</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.DateTime DateTime (Optionnel)]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Si renseignée, renvoi les bons qui ont été mouvementés après cette date et heure (UTC)</span></td></tr><tr><th class='parameter-name'>customers</th><td class='parameter-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.SiliconSalad+CustomerMultiId|CustomerMultiId]][]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Si renseigné, renvoi les bons qui ne concerne que ces clients. |
Précisez <code>customers=[null]</code> pour ne tirer que les bons non rattachés à un client en particulier, | Précisez <code>customers=[null]</code> pour ne tirer que les bons non rattachés à un client en particulier, | ||
<code>customers=[{codes:[1]}, null]</code> pour tirer les bons non rattachés à un client et ceux du client 1</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: 50000)<br/></span><span class='param-doc'>Nombre maximum de résultats (50000 maximum)</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.SiliconSalad+VoucherInfo|VoucherInfo]][]</td><td class='return-doc'>Liste des bons</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;'>être identifié</p></div></div> | <code>customers=[{codes:[1]}, null]</code> pour tirer les bons non rattachés à un client et ceux du client 1</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: 50000)<br/></span><span class='param-doc'>Nombre maximum de résultats (50000 maximum)</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.SiliconSalad+VoucherInfo|VoucherInfo]][]</td><td class='return-doc'>Liste des bons</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;'>être identifié</p></div></div> | ||
{{FinInfoCartographe}}[[Catégorie:Webservice SiliconSalad|GetVouchers]] | {{FinInfoCartographe}}[[Catégorie:Webservice SiliconSalad|GetVouchers]] | ||
Version du 18 juillet 2022 à 09:25
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 SiliconSalad permet de gérer la consultation et les mouvements de stocks par les site SiliconSalad.
Appel Web : https://nur298.ws-dev.polarisgestionmag.net/core/api/SiliconSalad.GetVouchers
VoucherInfo[] SiliconSalad.GetVouchers (Int32 CodeMagasin, [DateTime (Optionnel) lastDate = null], [CustomerMultiId[] customers = null], [Int32 limit = 50000], [xml|json output = xml ])
Obtient la liste des bons du système, par ordre de modification
Arguments :
| Nom | Type | Description |
|---|---|---|
| CodeMagasin | Int32 | Code magasin de référence de la validité des bons |
| lastDate | DateTime (Optionnel) | (optionnel, par défaut: null) Si renseignée, renvoi les bons qui ont été mouvementés après cette date et heure (UTC) |
| customers | CustomerMultiId[] | (optionnel, par défaut: null) Si renseigné, renvoi les bons qui ne concerne que ces clients. Précisez
customers=[{codes:[1]}, null] pour tirer les bons non rattachés à un client et ceux du client 1 |
| limit | Int32 | (optionnel, par défaut: 50000) Nombre maximum de résultats (50000 maximum) |
| output | xml|json | (optionnel, par défaut: xml) Format de la réponse |
| Retour | VoucherInfo[] | Liste des bons |
Politique de sécurité et règles d'accès à l'API :
être identifié