This shows you the differences between two versions of the page.
— |
design2budget:webservice:operation:get [2015/11/27 14:09] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== design2budget Entwickler Webservice Dokumentation ====== | ||
+ | Zurück zur [[design2budget:webservice|Webservice Dokumentation Startseite]] | ||
+ | |||
+ | ====== Basisoperation <module>/get ====== | ||
+ | |||
+ | Diese Action wird von jedem Modul angeboten und liefert ein bestimmtes Element des angegebenen Moduls mit der angegebenen id. | ||
+ | |||
+ | Jedes Element hat als primary key das Feld id. | ||
+ | |||
+ | ==== GET ==== | ||
+ | |||
+ | https://server/tenant/s/module/get/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/customer/get/10/?sid=9bd3b5f93692e4659632c8585eb35447 | ||
+ | |||
+ | Holt den Kunden 10 | ||
+ | |||
+ | ==== POST ==== | ||
+ | |||
+ | keine POST Parameter erforderlich | ||
+ | |||
+ | === Beispiel: JSON Return === | ||
+ | |||
+ | <code javascript> | ||
+ | { | ||
+ | "module":"customer", | ||
+ | "object": [{ | ||
+ | "id":"10", | ||
+ | "created_user":"1", | ||
+ | "created_user__id":"1", | ||
+ | "created_user__created_user":"0", | ||
+ | "created_user__created_ip":null, | ||
+ | "created_user__created_date":"0", | ||
+ | "created_user__modified_user":"1", | ||
+ | "created_user__modified_ip":"10.1.1.214", | ||
+ | "created_user__modified_date":"1422778828", | ||
+ | "created_user__email":"admin@example.com", | ||
+ | "created_user__tel":"+436641234567", | ||
+ | "created_user__username":"admin@example.com", | ||
+ | "created_user__status":"0", | ||
+ | "created_user__status_inactive_dt":"0", | ||
+ | "created_user__accesstype":"1024", | ||
+ | "created_user__firstname":"Chuck", | ||
+ | "created_user__lastname":"Tester", | ||
+ | "created_user__title":"", | ||
+ | "created_user__location_string":null, | ||
+ | "created_user__location_privacy":"0", | ||
+ | "created_user__location":"0", | ||
+ | "created_user__location_street":"", | ||
+ | "created_user__location_city":"", | ||
+ | "created_user__location_zip":"0", | ||
+ | "created_user__location_country":"", | ||
+ | "created_user__partner":"0", | ||
+ | "created_ip":"10.1.1.56", | ||
+ | "created_date":"1374853462", | ||
+ | "modified_user":"1", | ||
+ | "modified_user__id":"1", | ||
+ | "modified_user__created_user":"0", | ||
+ | "modified_user__created_ip":null, | ||
+ | "modified_user__created_date":"0", | ||
+ | "modified_user__modified_user":"1", | ||
+ | "modified_user__modified_ip":"10.1.1.214", | ||
+ | "modified_user__modified_date":"1422778828", | ||
+ | "modified_user__email":"admin@example.com", | ||
+ | "modified_user__tel":"+436641234567", | ||
+ | "modified_user__username":"admin@example.com", | ||
+ | "modified_user__status":"0", | ||
+ | "modified_user__status_inactive_dt":"0", | ||
+ | "modified_user__accesstype":"1024", | ||
+ | "modified_user__firstname":"Chuck", | ||
+ | "modified_user__lastname":"Tester", | ||
+ | "modified_user__title":"", | ||
+ | "modified_user__location_string":null, | ||
+ | "modified_user__location_privacy":"0", | ||
+ | "modified_user__location":"0", | ||
+ | "modified_user__location_street":"", | ||
+ | "modified_user__location_city":"", | ||
+ | "modified_user__location_zip":"0", | ||
+ | "modified_user__location_country":"", | ||
+ | "modified_user__partner":"0", | ||
+ | "modified_ip":"10.1.1.56", | ||
+ | "modified_date":"1433403902", | ||
+ | "record_status":"0", | ||
+ | "status":"0", | ||
+ | "status_change_dt":"0", | ||
+ | "ctype":"1", | ||
+ | "lastname":"Mustermann", | ||
+ | "firstname":"Max", | ||
+ | "title":"1", | ||
+ | "company":"Musterfirma", | ||
+ | "comboname":"Fa. Musterfirma \/ Herr Max Mustermann ", | ||
+ | "comboname2":"Mustermann Max Musterfirma", | ||
+ | "zip":"1234", | ||
+ | "city":"Nockendorf", | ||
+ | "street":"Obere Umfahrungsstr. 13b", | ||
+ | "country":"\u00d6sterreich", | ||
+ | "email":"mustermann@example.com", | ||
+ | "phone":"01\/12321", | ||
+ | "mobile":"060 06060 6", | ||
+ | "fax":"fffax", | ||
+ | "web":"", | ||
+ | "vatno":"AT1234565", | ||
+ | "code":null, | ||
+ | "paymenttype":null, | ||
+ | "paymentinfo":null, | ||
+ | "annexoffer":null, | ||
+ | "annexinvoice":null, | ||
+ | "discount":"0", | ||
+ | "tax":"0", | ||
+ | "description":null, | ||
+ | "istemplate":"0", | ||
+ | "mainatt":"0", | ||
+ | "mainatt__id":null,"mainatt__created_user":null,"mainatt__created_ip":null,"mainatt__created_date":null,"mainatt__modified_user":null,"mainatt__modified_ip":null,"mainatt__modified_date":null,"mainatt__customer":null,"mainatt__positiongroup":null,"mainatt__article":null,"mainatt__offer":null,"mainatt__order":null,"mainatt__invoice":null,"mainatt__dunning":null,"mainatt__position":null,"mainatt__user":null,"mainatt__inoutexpenses":null,"mainatt__settings":null,"mainatt__sysevents":null,"mainatt__direction":null,"mainatt__type":null,"mainatt__code":null,"mainatt__sentdate":null,"mainatt__readdate":null,"mainatt__filename":null,"mainatt__tempname":null,"mainatt__filetype":null,"mainatt__summary":null,"mainatt__description":null,"mainatt__token":null, | ||
+ | "lastcorrespondence":"0", | ||
+ | "lastcorrespondence__id":null,"lastcorrespondence__created_user":null,"lastcorrespondence__created_ip":null,"lastcorrespondence__created_date":null,"lastcorrespondence__modified_user":null,"lastcorrespondence__modified_ip":null,"lastcorrespondence__modified_date":null,"lastcorrespondence__actiondate":null,"lastcorrespondence__customer":null,"lastcorrespondence__offer":null,"lastcorrespondence__order":null,"lastcorrespondence__invoice":null,"lastcorrespondence__dunning":null,"lastcorrespondence__user":null,"lastcorrespondence__direction":null,"lastcorrespondence__type":null,"lastcorrespondence__code":null,"lastcorrespondence__summary":null,"lastcorrespondence__description":null,"lastcorrespondence__data":null,"lastcorrespondence__mainatt":null,"linkurl":null,"salesuser":"0", | ||
+ | "location":"0", | ||
+ | "_representationname":"Herr Max Mustermann (Musterfirma)", | ||
+ | "created_user___representationname":"admin@example.com (Mustermann, Max)", | ||
+ | "modified_user___representationname":"admin@example.com (Mustermann, Max)", | ||
+ | "mainatt___representationname":"attachment:", | ||
+ | "lastcorrespondence___representationname":"correspondence:10", | ||
+ | }], | ||
+ | "errormsg":[] | ||
+ | } | ||
+ | </code> |