do_GetSettingsDescriptions_Ad [dstore]

Inhaltsverzeichnis

do_GetSettingsDescriptions_Ad

do_GetSettingsDescriptions_Ad

Gibt zu einem oder mehreren Schlüsseln aus den verschiedenen „Settings“-Tabellen die erlaubten Datentypen, eine kurze Beschreibungen sowie einige weitere Informationen (s. Rückgabemenge) zurück.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[do, Get, Settings, Descriptions, Ad]
Engine-Kategorie	documentation
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
SettingsTable	NULL	Nur Settings einer Tabelle zurückgeben. Mögliche Werte: - „AuctionItemSettings“ - „AuctionParticipantSettings“ - „CommunityMemberSettings“ - „CommunitySettings“ - „ForumSettings“ - „NodeCharacteristicSettings“ - „PersonTypeSettings“ - „Settings“	varchar(30)	3.5.16
KeyVariable	NULL	Ein Schlüssel, nach dem gefiltert werden soll	varchar(50)	3.5.16
SettingsEntryCategoryID	NULL	ID einer Kategorie von Settings-Einträgen, nach der gefiltert werden soll (z.B. „Person Management“, siehe Prozedur do_GetSettingsEntryCats_Ad)	tinyint	3.5.16

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
SettingsTable	Name einer „Settings“-Tabelle des „dStore“ (mögliche Werte siehe Parameter „SettingsTable“)	varchar(30)	3.5.16
KeyVariable	Ein möglicher Schlüssel, zu dem in der durch „SettingsTable“ angegebenen Tabelle ein Wert hinterlegt werden kann	varchar(50)	3.5.16
DataTypeForValue	Von welchem Datentyp müssen die Werte zum Schlüssel „KeyVariable“ sein	varchar(30)	3.5.16
SettingsEntryCategoryID	ID einer Kategorie von „Settings“-Einträgen	tinyint	3.5.16
SettingsEntryCategory	Bezeichnung der Kategorie „SettingsEntryCategoryID“	varchar(100)	3.5.16
Required	„0“ : Optionaler Schlüssel, d.h. er wird nur für irgendeine ZUSÄTZLICHE Funktionalität benötigt „1“ : Zwingend für den laufenden Betrieb des „dStore“ erforderlich	bit	3.5.16
UserDependent	„0“ : Der Schlüssel „KeyVariable“ gilt „global“, d.h. für ALLE Benutzer (aus „UserInfo“) bzw. Personen (CommunityMitglieder etc.) im „dStore“ „1“ : Einstellungen zum Schlüssel gelten nur für einen Benutzer bzw. für eine Person (Auktions-Teilnehmer etc.)	bit	3.5.16
dStoreVersion	Seit welcher „dStore“-Version gibt es den Schlüssel „KeyVariable“	varchar(20)	3.5.16
Description	Eine Beschreibung, wozu der Schlüssel „KeyVariable“ benötigt/verwendet wird	text	3.5.16

Sortierung der Rückgabe

(parameterunabängige Sortierung)

SettingsTable (aufsteigend)
SettingsEntryCategory (aufsteigend)
KeyVariable (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-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 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.4	2013-04-29	Anpassungen an aktuellen Code-Standard
6.5.3	2013-03-18	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
4.0.10	2004-03-15	1. „_mi_StartProcedure“, „_mi_FinishProcedure“ und „_mi_ChooseParamValueSeperator“ 2. „set transaction isolation level 1“, „set rowcount 0“ 3. Fehlende/Falsche „optimizer“- bzw. Index-Angaben 4. Fehler in der Doku
3.5.22	2002-08-30
3.5.18	2002-05-15
3.5.16	2002-04-25	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:

do_GetSettingsDescriptions_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/do_GetSettingsDescriptions_Ad'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/do_GetSettingsDescriptions_Ad' | 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'),
	'do_GetSettingsDescriptions_Ad',
		array(
			// 'SettingsTable' => NULL,
			// 'KeyVariable' => NULL,
			// 'SettingsEntryCategoryID' => NULL
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();

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="do_GetSettingsDescriptions_Ad">
			<Parameters>
				<!-- <Parameter Name="SettingsTable">NULL</Parameter> -->
				<!-- <Parameter Name="KeyVariable">NULL</Parameter> -->
				<!-- <Parameter Name="SettingsEntryCategoryID">NULL</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