mi_GetSettingEntry [dstore]

Inhaltsverzeichnis

mi_GetSettingEntry

mi_GetSettingEntry

Liefert den hinterlegten Wert aus „Settings“ zu einem bestimmten Benutzer und einem bestimmten Schlüssel.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[mi, Get, Setting, Entry]
Engine-Kategorie	miscellaneous
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	4.0.5 (2003-10-04)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
UserID	-1	ID eines „dStore“-Benutzers, der in „UserInfo“ registriert ist (siehe mi_GetUserInfo_Ad). Anmerkung: Es gibt einen speziellen Benutzer mit der ID „-1“, durch den GLOBALE Einstellungen gekennzeichnet werden.	smallint	3.5.0
KeyVariable		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' “.	varchar(50)	3.5.0
SelectResult	0	„0“ : Der zum Schlüsel „KeyVariable“ hinterlegte Wert wird NUR über den Ausgabeparameter „Value“ zurückgegeben „1“ : Es wird ZUSÄTZLICH eine Rückgabemenge bereitgestellt	bit	3.5.0

Rückgabe

wenn SelectResult = 1

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
Value	Der für den Benutzer „UserID“ zum Schlüssel „KeyVariable“ hinterlegte Wert	varchar(100)	3.5.0

Output-Parameter

Value

Ausgabeparameter für den zum Schlüssel „KeyVariable“ (für den Benutzer „UserID“) hinterlegten Wert

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-621	Fehlender oder falscher Eintrag in PersonTypeSettings	nur direkt
-550	Fehlender oder falscher Eintrag in Settings	nur direkt

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

4.0.5	2003-10-04	Verlagerung diverser „Settings“-Einträge auf entsprechende „PersonTypeSettings“-Einträge, daher [wg. Abwärtskompatibilität] sind die betroffenen „KeyVariable“-Werte hier „hart“ codiert und werden entsprechend aus „PersonTypeSettings“ ermittelt
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:

mi_GetSettingEntry im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetSettingEntry?KeyVariable=<value>'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetSettingEntry?KeyVariable=<value>' | xmllint --format -

dStore_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_GetSettingEntry',
		array(
			'KeyVariable' => '<value>',
			// 'UserID' => -1,
			// 'SelectResult' => 0
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();
 
$OutputParams = $xml_result->getOutputParametersAsArray();

engine/execute

XML zur Ausführung mit der Methode engine/execute, z.B. per

curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>'

<?xml version="1.0" encoding="UTF-8"?>
<ListOfBatches>
	<Batch No="0">
		<Procedure Name="mi_GetSettingEntry">
			<Parameters>
				<Parameter Name="KeyVariable"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="UserID">-1</Parameter> -->
				<!-- <Parameter Name="SelectResult">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“

⁶⁾

I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Inhaltsverzeichnis