Differences

This shows you the differences between two versions of the page.

--- offer-cube:webservice [2017/05/07 18:19]
+++ offer-cube:webservice [2017/05/07 18:19] (current)
@@ Line 1: / Line 1: @@
+====== offer-cube Entwickler Webservice Dokumentation ======
+===== Allgemeines =====
+Das Webservice ist eine REST API und verfügbar als JSON REST API oder XML REST API (siehe outputMode).
+| Basis Aufruf (URL) | https://www.detobu.at/<ihr-kuerzel>/s/<module>/<action>/<id>/?sid=<sessionId>[&output=<outputMode>][&parameter...] |
+<ihr-kuerzel> ist das Kürzel, dass Sie bei der Registrierung gewählt haben.
+Der Parameter <module> gibt das entsprechende Zielmodul an.
+Der Parameter <action> und <id> gibt die im Zielmodul auszuführende Aktion mit einer Optionalen ID an.
+Der Parameter sid=<sessionId> muss angegeben werden um sich gegenüber dem Server als eingeloggt auszuweisen (Die Session ID wird mittels im Modul users mit der Aktion login vergeben)
+Mit dem optionalen Parameter output=<outputMode> kann von der standardmäßigen JSON REST API (output=json) auf die XML REST API (output=xml) gewechselt werden.
+Je nach gewählter Aktion kann es zusätzlich noch optionale GET Parameter geben.
+Grundsätzlich werden jedoch sämtliche Parameter als POST übergeben.
+===== Basis Operationen =====
+Jedes Modul bietet folgende Basisfunktionen:
+^ action     ^ Beschreibung                         ^
+| [[offer-cube:webservice:operation:list]]       | Liste/Suche                          |
+| [[offer-cube:webservice:operation:count]]      | Gesamtanzahl der Ergebnisse von list |
+| [[offer-cube:webservice:operation:get]]        | Details eines Elements mit angegebener ID |
+| [[offer-cube:webservice:operation:save]]       | Speichern - neu oder update - eines Elements mit angegebener ID |
+| [[offer-cube:webservice:operation:schema]]     | Datenbank Schema des Moduls          |
+Über diese Basis Operationen lässt sich jedes Objekt im System finden und/oder Ändern.
+Zusätzlich stehen noch einige spezielle Aktionen, die jeweils nur für ein bestimmtes Modul gelten, zur Verfügung.
+==== Login / Logout ====
+Sind jeweils als Aktionen login und logout im Modul [[offer-cube:webservice:modules:users]] abgebildet
+===== Module =====
+Im jeweiligen Modul sind die zusätzlich vorhandenen Funktionen beschrieben:
+^ Module     ^ Beschreibung          ^
+| [[offer-cube:webservice:modules:users]]           | Benutzer Verwaltung inkl. login und logout |
+| [[offer-cube:webservice:modules:customer]]        | Kunden                      |
+| [[offer-cube:webservice:modules:offer]]           | Angebote                    |
+| [[offer-cube:webservice:modules:order]]           | Aufträge                    |
+| [[offer-cube:webservice:modules:invoice]]         | Rechnungen und Mahnungen    |
+| [[offer-cube:webservice:modules:dunning]]         | Mahnungen (nur Meta Daten)  |
+| [[offer-cube:webservice:modules:inoutexpenses]]   | Einnahmen/Ausgaben Rechnung |
+| [[offer-cube:webservice:modules:position]]        | Positionen                  |
+| [[offer-cube:webservice:modules:article]]         | Artikel Stammdaten          |
+| [[offer-cube:webservice:modules:articleinstance]] | Artikel Instanzen           |
+| [[offer-cube:webservice:modules:articlegroup]]    | Artikelgruppen              |
+| [[offer-cube:webservice:modules:provider]]        | Lieferanten                 |
+| [[offer-cube:webservice:modules:correspondence]]  | CRM Modul                   |
+| [[offer-cube:webservice:modules:label]]           | Label                       |
+| [[offer-cube:webservice:modules:labelinstance]]   | Label Instanzen             |
+| [[offer-cube:webservice:modules:attachment]]      | Attachments                 |

cubic zebra

User Tools

Site Tools

Differences

Page Tools