engine:procedures:mi_getsettings_ad
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
|
engine:procedures:mi_getsettings_ad [11.01.2016 ] |
engine:procedures:mi_getsettings_ad [11.01.2016 ] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ===== mi_GetSettings_Ad ===== | ||
| + | |||
| + | Liefert alle oder nur bestimmte Einträge aus "Settings" zurück. Diese Tabelle enthält globale sowie Benutzer-spezifische Einstellungen.\\ | ||
| + | |HTTP-Method|GET | | ||
| + | |HTTP-Auth|Optional | | ||
| + | |Tags|{{tag>[mi Get Settings Ad]}}| | ||
| + | |Engine-Kategorie|basics | | ||
| + | |Engine-Typ|Daten-Ermittlung | | ||
| + | |Letzte Aktualisierung|7.0.7 (2015-01-29)| | ||
| + | |||
| + | ==== Parameter ==== | ||
| + | |||
| + | ^Name ((Pflichtparameter sind unterstrichen)) ^Standard-Wert ^Beschreibung ((siehe [[webservice:engine_parameterconventions|Parameter-Konventionen engine/<Prozedur-Name>]])) ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |UserID|NULL |ID eines "dStore"-Benutzers, der in "UserInfo" registriert ist (siehe [[dstoreproc>mi_GetUserInfo_Ad]]).\\ Anmerkung: Es gibt einen speziellen Benutzer mit der ID "-1", durch den GLOBALE Einstellungen gekennzeichnet werden. ("NULL" bedeutet keine Einschränkung...)\\ |smallint|3.5.0| | ||
| + | |KeyVariable|NULL |Ein Schlüssel (z.B. "dStore-Version"), zu dem der hinterlegte Wert ausgegeben werden soll. Mögliche Werte : siehe Rückgabemenge von " do_GetSettingsDescriptions_Ad 'Settings' ". ("NULL" bedeutet keine Einschränkung...)\\ |varchar(50)|3.5.0| | ||
| + | |SearchForKeyVariableWithLike|0 |Ist "KeyVariable" belegt, wird hierdurch angegeben, ob der Schlüssel GENAU angegeben wurde ("0") oder ob er "wildcards" ("%" für eine beliebige Zeichenkette, "_" für ein beliebiges Zeichen) enthält und mit dem "LIKE"-Operator gesucht werden soll ("1")\\ |bit|4.0.7| | ||
| + | ==== Rückgabe ==== | ||
| + | |||
| + | === (parameterunabhängig) === | ||
| + | |||
| + | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |UserID|ID eines im "dStore" registrierten Benutzers (aus der Tabelle "UserInfo"), zu dem "Value" zum Schlüssel "KeyVariable" hinterlegt ist.\\ Anmerkung: Es gibt einen speziellen Benutzer mit der ID "-1", durch den GLOBALE Einstellungen gekennzeichnet werden.\\ |smallint|3.5.0 | | ||
| + | |UserName|Name des Benutzers "UserID"\\ |varchar(50)|3.5.0 | | ||
| + | |KeyVariable|Ein Schlüssel (z.B. "dStore-Version"). Mögliche Werte : siehe Rückgabemenge von " do_GetSettingsDescriptions_Ad 'Settings' "\\ |varchar(50)|3.5.0 | | ||
| + | |Value|Der für den Benutzer "UserID" zum Schlüssel "KeyVariable" hinterlegte Wert\\ |varchar(100)|3.5.0 | | ||
| + | ==== Output-Parameter ==== | ||
| + | |||
| + | Die Prozedur hat keine Output-Parameter.==== Mögliche Return-Codes ==== | ||
| + | |||
| + | ^Code ^Beschreibung ^Quelle ((direkt meint "von der Prozedur selber" und indirekt meint "von intern aufgerufenen Unterprozeduren")) ^ | ||
| + | |-569|Der Benutzer hat kein Ausführungsrecht für die Prozedur|nur indirekt| | ||
| + | |-567|Die Prozedur darf z. Zt. nicht ausgeführt werden|nur indirekt| | ||
| + | |-566|Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werden|nur indirekt| | ||
| + | |-535|Das Datum liegt nicht in der Vergangenheit|nur indirekt| | ||
| + | |-530|Der Wert ist nicht konvertierbar|nur indirekt| | ||
| + | |-510|Der Benutzer ist nicht registriert|nur indirekt| | ||
| + | |-504|Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochen|nur indirekt| | ||
| + | |-502|Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)|nur indirekt| | ||
| + | |-500|Falsche Parameter|nur indirekt| | ||
| + | ==== XML-Schema ==== | ||
| + | |||
| + | Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema [[http://resources.dstore.de/xsd/webservice_SmartGate/Response/EngineProcedure_v1_0.xsd|Response/EngineProcedure_v1_0.xsd]] validiert. | ||
| + | ==== Historie ==== | ||
| + | |||
| + | |7.0.7 |2015-01-29|Interne Änderung : Datentyp-Erweiterung des "ReferenceKey" [für "_mi_StartProcedure"-Aufruf]\\ | | ||
| + | |6.5.3 |2013-03-18|Anpassungen an den aktuellen Quellcode-Standard, u.a. wg. UTF8-Unterstützung\\ | | ||
| + | |4.0.14 |2004-06-03|1. Aufruf der Prozeduren "_mi_StartProcedure", "_mi_FinishProcedure" und "_mi_ChooseParamValueSeperator" \\ 2. Ausführen von "set transaction isolation level 1" und "set rowcount 0" zu Beginn der Prozedur\\ | | ||
| + | |4.0.7 |2004-01-16|Neuer Parameter "SearchForKeyVariableWithLike"\\ | | ||
| + | |3.5.0 |2000-11-23|Erstmalig in dieser Version erstellt\\ | | ||
| + | |||
| + | ==== Code-Snippets ==== | ||
| + | |||
| + | == Engine Playground == | ||
| + | Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist: | ||
| + | * [[http://playground.dstore.de/index.php?proc=mi_GetSettings_Ad|mi_GetSettings_Ad im Engine Playground öffnen]] | ||
| + | == cURL == | ||
| + | Unformatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/mi_GetSettings_Ad'</code>Mit xmllint ((I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org)) formatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/mi_GetSettings_Ad' | xmllint --format -</code>== dStore_php == | ||
| + | <code php> | ||
| + | use dStore_php\WebService; | ||
| + | |||
| + | $service = new WebService\Service( WebService\Scheme::HTTP,'<partner>-<project>.dstore.de', 80); | ||
| + | |||
| + | $request = new WebService\Requests\Engine\Procedure\Request( | ||
| + | new WebService\Requests\AccessData('default'), | ||
| + | 'mi_GetSettings_Ad', | ||
| + | array( | ||
| + | // 'UserID' => NULL, | ||
| + | // 'KeyVariable' => NULL, | ||
| + | // 'SearchForKeyVariableWithLike' => 0 | ||
| + | ) | ||
| + | ); | ||
| + | |||
| + | $service->execute($request); | ||
| + | |||
| + | $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); | ||
| + | $ResultSet = $xml_result->getRowsAsArray(); | ||
| + | |||
| + | </code> | ||
| + | == engine/execute == | ||
| + | XML zur Ausführung mit der Methode [[:webservice:engine:execute|engine/execute]], z.B. per | ||
| + | curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>' | ||
| + | |||
| + | <code xml> | ||
| + | <?xml version="1.0" encoding="UTF-8"?> | ||
| + | <ListOfBatches> | ||
| + | <Batch No="0"> | ||
| + | <Procedure Name="mi_GetSettings_Ad"> | ||
| + | <Parameters> | ||
| + | <!-- <Parameter Name="UserID">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="KeyVariable">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="SearchForKeyVariableWithLike">0</Parameter> --> | ||
| + | </Parameters> | ||
| + | </Procedure> | ||
| + | </Batch> | ||
| + | </ListOfBatches></code> | ||
engine/procedures/mi_getsettings_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)