IWS/API IWS3/productListAction REST

Aus ITscope GmbH - Wissensbasis

Wechseln zu: Navigation, Suche
productListAction
aktuelle Version

Inhaltsverzeichnis

1 Beschreibung

productListAction verwaltet die im MarketViewer sichtbaren Produktlisten. Die Methode kann verwendet werden, um automatisiert Produktlisten zu erzeugen, zu löschen, Produkte hinzuzufügen oder wieder zu entfernen.

Beispielanwendungen: Angebote und Bestell-Listen aus der Warenwirtschaft übernehmen, dynamische Produktlisten aus Produktexporten erstellen etc.

2 Ähnliche Methoden

keine

3 Parameter

3.1 Allgemeine Parameter

Die folgenden Parameter können für jede Methode verwendet werden.

Name des Parameters Beschreibung Benötigt Zulässige Werte
validate Ist validate = true, wird die Anfrage nicht ausgeführt, sondern nur auf syntaktische und inhaltliche Korrektheit überprüft (z.B. ob Parameterwerte stimmen oder plausibel sind) Optional
  • true
  • false (default)
iwsKey Der Webservice-Nutzungskey für ITscope-Kunden. Nur mit diesem Key können Web Service Requests ausgeführt werden. Ja Ihr IWS-Key, zum Beispiel: 
qnAGOar2dsAIo1EnThWsKA
. Sie erhalten den Key bei der Registrierung als Enterprise-User bei ITscope.

3.2 Spezielle Parameter

Name des

Parameters

Beschreibung Benötigt Zulässige Werte
name Produklisten Name Nein /Ja - Operation abhängig Text
listid Produklisten ID Nein /Ja - Operation abhängig Numerisch
itsPid ITscope Produktnummer Nein /Ja - Operation abhängig Kommaseparierte Liste von Produktnummern
operation Die Operation für die Produktliste Ja
  • query - Alle Produktlisten anzeigen
  • create - Produktliste erstellen
  • addProducts - Produkte hinzufügen
  • removeProducts - Produkte entfernen
  • clear - Produktliste leeren
  • delete - Produktliste löschen

4 Beispielaufrufe

4.1 REST

4.1.1 Request 

/* 
* Alle dem Kundenkonto zugeordneten Produktlisten anzeigen
*/
http://iws.itscope.de/rest/productListAction?iwsKey=<IhrWebserviceKey>&operation=query 
 
 
/* 
* Produktliste anlegen 
*/
http://iws.itscope.de/rest/productListAction?iwsKey=<IhrWebserviceKey>&name=Produktlistenname&operation=create 
 
 
/*
* Produkte hinzufügen
* Dieser Request fügt 2 Produkte zur Produktliste mit der ID 165183489 hinzu (diese ID  erhalten in der Antwort auf operation=create)
*/
http://iws.itscope.de/rest/productListAction?iwsKey=<IhrWebserviceKey>&listId=165183489&operation=addProducts&itsPid=1079047000,117313000
 
 
/*
* Produkte löschen 
*/
http://iws.itscope.de/rest/productListAction?iwsKey=<IhrWebserviceKey>&listId=165183489&operation=removeProducts&itsPid=1079047000
 
 
/*
* Alle Produkte löschen
*/
http://iws.itscope.de/rest/productListAction?iwsKey=<IhrWebserviceKey>&listId=165183489&operation=clear
 
 
/* 
* Produktliste löschen
*/
http://iws.itscope.de/rest/productListAction?iwsKey=<IhrWebserviceKey>&name=Produktlistenname&operation=delete

4.1.2 Response

Erfolgreiches Setzen von Produkten auf eine Produktliste 

<its:productListResponse xmlns:its="http://www.itscope.de/IWS/2006-04-20">
   <its:responseHeader>
      <its:requestId>1608807424</its:requestId>
      <its:customerId><IhreITscopeKundenummer></its:customerId>
      <its:processingTime>361</its:processingTime>
      <its:serverMasterdataTimestamp>0</its:serverMasterdataTimestamp>
      <its:messageDate>2010-03-21T12:47:26.925+01:00</its:messageDate>
   </its:responseHeader>
</its:productListResponse>


Fehler beim Setzen von Produkten auf eine Produktliste die noch nciht vorhanden ist, diese sollte mit create davor erzeugt werden 

<its:productListResponse xmlns:its="http://www.itscope.de/IWS/2006-04-20">
   <its:responseHeader>
      <its:requestId>1608821144</its:requestId>
      <its:customerId><IhreITscopeKundenummer></its:customerId>
      <its:processingTime>297</its:processingTime>
      <its:errors>
         <its:exceptionMessage>Container muß spezifiziert werden bzw. konnte nicht geladen werden.</its:exceptionMessage>
         <its:exceptionCode>103</its:exceptionCode>
      </its:errors>
      <its:serverMasterdataTimestamp>0</its:serverMasterdataTimestamp>
      <its:messageDate>2010-03-21T12:57:25.193+01:00</its:messageDate>
   </its:responseHeader>
</its:productListResponse>

Erfolgreiches Ausführen einer Query Operation. Die Produktliste ID für die anderen Operationen auf Produktlisten stehen im Element <its3:id> hinter der Kennung VIE. 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<its:productListResponse xmlns:its="http://www.itscope.de/IWS/2006-04-20" xmlns:its3="http://www.itscope.de/IWS3/2008-05-01">
    <its:responseHeader>
        <its:customerId>xxx</its:customerId>
        <its:processingTime>429</its:processingTime>
        <its:serverMasterdataTimestamp>0</its:serverMasterdataTimestamp>
    </its:responseHeader>
    <its:productLists>
        <its3:id>VIE1</its3:id>
        <its3:name>Produktliste1</its3:name>
    </its:productLists>
    ...
    <its:productLists>
        <its3:id>VIE2</its3:id>
        <its3:name>Produktliste2</its3:name>
    </its:productLists>
    ...
    <its:productLists>
        <its3:id>VIE3</its3:id>
        <its3:name>Produktliste3</its3:name>
    </its:productLists>
</its:productListResponse>
Von „http://www.itscope.de/wiki/IWS/API_IWS3/productListAction_REST“