User Tools

Site Tools


design2budget:webservice

This is an old revision of the document!


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>][&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
list Suche mit Wildcards
listexact Suche ohne Wildcards
count Gesamtanzahl der Ergebnisse von list
countexact Gesamtanzahl der Ergebnisse von listexact
get Details eines Elements mit angegebener ID
save Speichern - neu oder update - eines Elements mit angegebener ID
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 users abgebildet

Module

Im jeweiligen Modul sind die zusätzlich vorhandenen Funktionen beschrieben:

Module Beschreibung
users Benutzer Verwaltung
customer Kunden
offer Angebote
order Aufträge
invoice Rechnungen und Mahnungen
dunning Mahnungen (nur Meta Daten)
position Positionen
article Artikel Stammdaten
articleinstance Artikel Instanzen
articlegroup Artikelgruppen
provider Lieferanten
correspondence CRM Modul
attachment Attachments
design2budget/webservice.1428173670.txt.gz · Last modified: 2017/03/19 09:52 (external edit)