Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen Revision Vorhergehende Überarbeitung | |||
webservice:engine_parameterconventions [01.04.2014 ] 172.16.1.171 [x-www-form-urlencoded] |
webservice:engine_parameterconventions [13.11.2014 ] (aktuell) |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
+ | ===== Parameter-Konventionen engine/<Prozedur-Name> ===== | ||
+ | Hinsichtlich der Parameterübergabe bei Methoden engine/<Prozedur-Name> gelten folgende Konventionen: | ||
+ | |||
+ | * Es sind nur Parameter erlaubt, die die entsprechende Prozedur auch unterstützt. Dies sei hier erwähnt, da bei anderen Methoden des [[webservice:|webservice_SmartGate]] das Verhalten anders sein kann, d.h. unnötige Parameter ignoriert werden. | ||
+ | * Alle Pflichtparameter müssen angegeben werden. | ||
+ | * Für nicht angegebene Parameter wird intern der Standard-Wert verwendet, welchen man der Dokumentation entnehmen kann (dieser muss nicht immer ''NULL'' sein). | ||
+ | * Übergabe des Wertes ''NULL'' mittels Parameter ohne Wert, Bsp: ''<Prozedurname>?ErsterParameter=&NextParameter=...'' | ||
+ | * Übergabe eines leeren Strings mit doppelten Anführungszeichen, Bsp: ''<Prozedurname>?ErsterParameter=""&NextParameter=...'' | ||
+ | * Übergabe eines nicht-leeren Strings als URL-encodeter Parameter, Bsp: ''<Prozedurname>?ErsterParameter=Ich%20bin%20Param&NextParameter=...'' | ||
+ | * Übergabe von Datums-/Zeitparametern im [[google>xsd:DateTime]]-Format ''[-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]'' | ||
+ | |||
+ | ==== x-www-form-urlencoded ==== | ||
+ | |||
+ | Bei POST-Requests gibt es eine alternative Möglichkeit der Übergabe von Parametern im Body der Anfrage in Form einer ''x-www-form-urlencoded''-Kodierung (sofern man nicht die Methode [[webservice:engine:execute|engine/execute]] verwenden möchte). Dies ist insbesondere dann sinnvoll wenn der Request-String durch die Länge der Parameter festgelegte Grenzen überschreitet (i.d.R. ab 2-4 KB). Anwendung findet dies z.B. bei der Änderung einer grossen Menge von Personeneigenschaften oder dem Einfügen von Bilddaten. | ||
+ | |||
+ | Es gilt: wenn es bei einem POST-Request einen Request Header ''Content-Type: application/x-www-form-urlencoded'' (ggf. auch mit charset-Erweiterung) gibt dann sind die übergebenen Parameter zusätzlich zu den Query Parametern wie selbige zu behandeln. Es ist also egal ob ein Parameter als Query-Parameter des Requests oder im Body in ''x-www-form-urlencoded''-Kodierung steht. |