Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
— |
engine:procedures:mi_getapplicationsettings_ad [11.01.2016 ] (aktuell) |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
+ | ===== mi_GetApplicationSettings_Ad ===== | ||
+ | |||
+ | Gibt Einstellungen zu dStore-Anwendungen aus.\\ | ||
+ | |||
+ | Darunter sind jegliche Arten von Anwendungen zu verstehen, die auf dem "dStore" basieren. Für den dStore selbst hat die Registrierung von solchen Anwendungen keine Bedeutung, aber mit Hilfe von [[dstoreproc>mi_ModifyAppSettings_Ad]] können benutzerspezifische Einstellungen gespeichert werden (s. a. [[dstoreproc>mi_ModifyAppPartSettings_Ad]]).\\ | ||
+ | |HTTP-Method|GET | | ||
+ | |HTTP-Auth|Optional | | ||
+ | |Tags|{{tag>[mi Get Application 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 ^ | ||
+ | |__ApplicationID__| |ID einer registrierten "dStore"-Anwendung, zu der Einstellungen ausgegeben werden sollen\\ |smallint|4.0.8| | ||
+ | |UserID|NULL |ID eines "dStore"-Benutzers, der in "UserInfo" registriert ist (siehe [[dstoreproc>mi_GetUserInfo_Ad]]). Falls angegeben, werden nur die Einstellungen dieses Benutzers ausgegeben, sonst die des Benutzers, der die Prozedur aufruft.\\ |smallint|4.0.8| | ||
+ | |KeyVariable|NULL |Name eines Schlüssels, zu dem der für den Benutzer "UserID" (bzw. für den die Prozedur aufrufenden Benutzer) hinterlegte Wert zurückgegeben werden soll. "NULL" angeben, um die Werte zu ALLEN hinterlegten Schlüsseln zu bekommen.\\ |varchar(100)|4.0.8| | ||
+ | |SearchForKeyVariableWithLike|0 |Wird nur beachtet, wenn "KeyVariable" nicht "NULL" ist. Auf "1" setzen, um die Werte zu allen Schlüsseln ermitteln zu lassen, die WIE "KeyVariable" aussehen (gesucht wird mit "LIKE", daher sind die T-SQL üblichen "wildcards" "%" und "_" erlaubt).\\ |bit|4.0.8| | ||
+ | |IncludeValuesForGlobalUser|1 |Ist zu einem Schlüssel kein Wert für den Benutzer angegeben, wird automatisch eine evtl. vorhandene Einstellung zur "UserID = -1" (für "globale" Einstellungen) ausgegeben, es sei denn, man übergibt hier "0"\\ |bit|4.0.8| | ||
+ | ==== Rückgabe ==== | ||
+ | |||
+ | === (parameterunabhängig) === | ||
+ | |||
+ | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
+ | |ApplicationID|Enthält z.Zt. immer "ApplicationID"\\ |smallint|4.0.8 | | ||
+ | |KeyVariable|Ein Schlüssel, zu dem der Wert "Value" für den Benutzer "UserID" (bzw. für den die Prozedur aufrufenden Benutzer) hinterlegt ist\\ |varchar(100)|4.0.8 | | ||
+ | |Value|Der Wert, der zum Schlüssel "KeyVariable" für den Benutzer "UserID" (bzw. für den die Prozedur aufrufenden Benutzer) hinterlegt ist\\ |text|4.0.8 | | ||
+ | |ValueDerivedFromGlobalUser|"1", falls "Value" zur "UserID = -1" gespeichert ist\\ |bit|4.0.8 | | ||
+ | |||
+ | == Sortierung der Rückgabe == | ||
+ | |||
+ | (parameterunabängige Sortierung) | ||
+ | * KeyVariable (aufsteigend) | ||
+ | |||
+ | ==== 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]\\ | | ||
+ | |7.0.2 |2013-08-29|Interne Anpassungen sowie Doku-Korrektur aufgrund der Erweiterung der "Value"-Spalte von "ApplicationSettings" auf\\ den Datentyp "text"\\ | | ||
+ | |6.5.3 |2013-03-18|Anpassungen an den aktuellen Quellcode-Standard, u.a. wg. UTF8-Unterstützung\\ | | ||
+ | |4.0.9 |2004-03-03|1. Verwendung von "_mi_ChooseParamValueSeperator" als Vorbereitung von "_mi_StartProcedure"\\ 2. Ausführen von "set transaction isolation level 1" und "set rowcount 0" zu Beginn der Prozedur\\ | | ||
+ | |4.0.8 |2004-02-20|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_GetApplicationSettings_Ad|mi_GetApplicationSettings_Ad im Engine Playground öffnen]] | ||
+ | == cURL == | ||
+ | Unformatierte Ausgabe: | ||
+ | <code bash> | ||
+ | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/mi_GetApplicationSettings_Ad?ApplicationID=<value>'</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_GetApplicationSettings_Ad?ApplicationID=<value>' | 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_GetApplicationSettings_Ad', | ||
+ | array( | ||
+ | 'ApplicationID' => <value>, | ||
+ | // 'UserID' => NULL, | ||
+ | // 'KeyVariable' => NULL, | ||
+ | // 'SearchForKeyVariableWithLike' => 0, | ||
+ | // 'IncludeValuesForGlobalUser' => 1 | ||
+ | ) | ||
+ | ); | ||
+ | |||
+ | $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_GetApplicationSettings_Ad"> | ||
+ | <Parameters> | ||
+ | <Parameter Name="ApplicationID"><!-- smallint value --></Parameter> | ||
+ | <!-- <Parameter Name="UserID">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="KeyVariable">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="SearchForKeyVariableWithLike">0</Parameter> --> | ||
+ | <!-- <Parameter Name="IncludeValuesForGlobalUser">1</Parameter> --> | ||
+ | </Parameters> | ||
+ | </Procedure> | ||
+ | </Batch> | ||
+ | </ListOfBatches></code> | ||