design2budget:webservice:operation:save
Differences
This shows you the differences between two versions of the page.
| — |
design2budget:webservice:operation:save [2015/11/27 14:09] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== design2budget Entwickler Webservice Dokumentation ====== | ||
| + | |||
| + | Zurück zur [[design2budget:webservice|Webservice Dokumentation Startseite]] | ||
| + | |||
| + | ====== Basisoperation <module>/save ====== | ||
| + | |||
| + | Diese Action wird von jedem Modul angeboten und speichert ein Objekt des angegebenen Moduls mit der angegebenen id. | ||
| + | |||
| + | Jedes Objekt hat als primary key das Feld id. | ||
| + | |||
| + | Wird statt einer gültigen id 0 angegeben, so wird ein neues Objekt erzeugt. | ||
| + | |||
| + | Die Feldwerte werden als POST Paramter übergeben. | ||
| + | |||
| + | ==== GET ==== | ||
| + | |||
| + | https://server/tenant/s/module/save/id/?sid=sessionID[&output=outputMode] | ||
| + | |||
| + | ^ parameter ^ Optional: Standard ^ Beschreibung ^ | ||
| + | | output | JA: json | JSON REST API (json) oder XML REST API (xml) | | ||
| + | |||
| + | Beispiel: | ||
| + | |||
| + | https://server/tenant/s/offer/save/312/?sid=9bd3b5f93692e4659632c8585eb35447 | ||
| + | |||
| + | Speichert das Angebot 312 | ||
| + | |||
| + | ==== POST ==== | ||
| + | |||
| + | Die einzelnen Werte für jedes Feld werden direkt als POST Parameter übergeben | ||
| + | |||
| + | ^ Parameter ^ Beschreibung ^ | ||
| + | | <field1>=<value1> | Das angegebene Feld field1 wird auf den Wert value1 gesetzt | | ||
| + | | <field2>=<value2> | Das angegebene Feld field2 wird auf den Wert value2 gesetzt | | ||
| + | | <field...>=<value...> | Jedes weitere Feld wird auf den entsprechenden Wert gesetzt | | ||
| + | |||
| + | **ACHTUNG:** Die Angabe der id als POST Paramter ist nicht zulässig! | ||
| + | |||
| + | === Beispiel1: Updaten eines Records === | ||
| + | |||
| + | https://server/tenant/s/customer/save/33/?sid=9bd3b5f93692e4659632c8585eb35447 | ||
| + | |||
| + | POST body: | ||
| + | <code> | ||
| + | lastname=Mustermann | ||
| + | firstname=Max | ||
| + | email=max.mustermann@domain.tld | ||
| + | </code> | ||
| + | |||
| + | Führt ein Update beim Kunden mit id 33 durch und speichert (überschreibt) die Felder lastname, firstname und email. | ||
| + | |||
| + | === Beispiel2: Neuanlage eines Records === | ||
| + | |||
| + | https://server/tenant/s/customer/save/0/?sid=9bd3b5f93692e4659632c8585eb35447 | ||
| + | |||
| + | POST body: | ||
| + | <code> | ||
| + | lastname=Mustermann | ||
| + | firstname=Max | ||
| + | email=max.mustermann@domain.tld | ||
| + | </code> | ||
| + | |||
| + | Legt einen neuen Kunden an und setzt die Felder lastname, firstname und email. | ||
| + | |||
design2budget/webservice/operation/save.txt · Last modified: 2015/11/27 14:09 (external edit)
Page Tools
