design2budget:webservice
Differences
This shows you the differences between two versions of the page.
|
design2budget:webservice [2015/04/04 20:54] 10.1.1.56 |
design2budget:webservice [2015/11/27 14:09] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== design2budget 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>][¶meter...] | | ||
| - | |||
| - | <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 ^ | ||
| - | | [[design2budget:webservice:operation:list]] | Suche mit Wildcards | | ||
| - | | [[design2budget:webservice:operation:list|listexact]] | Suche ohne Wildcards | | ||
| - | | [[design2budget:webservice:operation:count]] | Gesamtanzahl der Ergebnisse von list | | ||
| - | | [[design2budget:webservice:operation:count|countexact]] | Gesamtanzahl der Ergebnisse von listexact | | ||
| - | | [[design2budget:webservice:operation:get]] | Details eines Elements mit angegebener ID | | ||
| - | | [[design2budget:webservice:operation:save]] | Speichern - neu oder update - eines Elements mit angegebener ID | | ||
| - | | [[design2budget: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 [[design2budget:webservice:modules:users]] abgebildet | ||
| - | |||
| - | ===== Module ===== | ||
| - | |||
| - | Im jeweiligen Modul sind die zusätzlich vorhandenen Funktionen beschrieben: | ||
| - | |||
| - | ^ Module ^ Beschreibung ^ | ||
| - | | [[design2budget:webservice:modules:users]] | Benutzer Verwaltung | | ||
| - | | [[design2budget:webservice:modules:customer]] | Kunden | | ||
| - | | [[design2budget:webservice:modules:offer]] | Angebote | | ||
| - | | [[design2budget:webservice:modules:order]] | Aufträge | | ||
| - | | [[design2budget:webservice:modules:invoice]] | Rechnungen und Mahnungen | | ||
| - | | [[design2budget:webservice:modules:dunning]] | Mahnungen (nur Meta Daten) | | ||
| - | | [[design2budget:webservice:modules:position]] | Positionen | | ||
| - | | [[design2budget:webservice:modules:article]] | Artikel Stammdaten | | ||
| - | | [[design2budget:webservice:modules:articleinstance]] | Artikel Instanzen | | ||
| - | | [[design2budget:webservice:modules:articlegroup]] | Artikelgruppen | | ||
| - | | [[design2budget:webservice:modules:provider]] | Lieferanten | | ||
| - | | [[design2budget:webservice:modules:correspondence]] | CRM Modul | | ||
| - | | [[design2budget:webservice:modules:attachment]] | Attachments | | ||
| - | |||
design2budget/webservice.txt · Last modified: 2015/11/27 14:09 (external edit)
Page Tools
