/product

Mit den Methoden von /product wird das Produktmodell <productmodel>` kommuniziert.

  • POST /product initialisiert das XML-Produktmodell
  • GET /product gibt das komplette Produktmodell als Json zurück.

POST /product

Initialisiert das Produktmodell auf dem Server nach Validierung gegen das XSD Schema validiert.

URL : /product
method: POST
HeaderParam
  Apikey : <your registered user apikey>
  Sessionkey : <your temporary client session key>
consumes: application/xml
produces: ---

Das einmal initialisierte Produktmodell bleibt an die Session gebunden, das Modell sowie Nutzerentscheidungen bleiben für die Dauer der Session erhalten (TimeOut siehe API Settings). Bei jedem Client Reload sollte der ‘registered user’ eine neue Session für den Client via /cli-credentials erzeugen oder per DELETE /decision alle getroffenen Nutzerentscheidungen zurücksetzen.

Häufige Fehlerursachen

Intern wird das übergebene XML zunächst gegen das XSD Schema validiert. Jede Schema Verletzung führt automatisch zum Abbruch der Verarbeitung, die SAXException gibt entsprechende Hinweise auf die Fehlerursache.

Nach erfolgreicher Validierung kann es zu weiteren Fehlern beim Verarbeiten des XML kommen. Typische für manuell bearbeitete XML Files sind z.B. falsche Bezeichnungen (NameSpace) für die Referenzierung von ModelElementen in Constraints, die intern über BookKeeper NameSpaces identifiziert werden. Wird ein BookKeeper nicht gefunden, wird intern eine BadXmlDataException geworfen und eine Liste aller bekannten BookKeeper von der API zurück gegeben (text/plain).

Treten interne 500 Fehler auf, ist etwas unverhergesehen schief gegangen. Die API gibt den Inhalt der internen Exception aus. Es ist eher unwahrscheinlich, dass der 500er Fehler auf die Produktstruktur im XML zurückzuführen sein wird. Bitte daher zusätzlich das Error Log auswerten bzw. den Support kontaktieren.

GET /product

Das komplette Produktmodell wird als Json abgerufen.

URL : /product
method: GET
HeaderParam
  Apikey : <your registered user apikey>
  Sessionkey : <your temporary client session key>
consumes: --
produces: application/json (utf-8)

Response-Header:
  Accept-Encoding: gzip,deflate

403 Status:

  • Session ist nicht authorisiert. Auch bei Timeout (siehe API Settings).