Benutzer-Werkzeuge

Webseiten-Werkzeuge

Action disabled: source

engine:procedures: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-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategoriedocumentation
Engine-TypDaten-Ermittlung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
SettingsTableNULL Nur Settings einer Tabelle zurückgeben. Mögliche Werte:
- „AuctionItemSettings“
- „AuctionParticipantSettings“
- „CommunityMemberSettings“
- „CommunitySettings“
- „ForumSettings“
- „NodeCharacteristicSettings“
- „PersonTypeSettings“
- „Settings“
varchar(30)3.5.16
KeyVariableNULL Ein Schlüssel, nach dem gefiltert werden soll
varchar(50)3.5.16
SettingsEntryCategoryIDNULL ID einer Kategorie von Settings-Einträgen, nach der gefiltert werden soll (z.B. „Person Management“, siehe Prozedur do_GetSettingsEntryCats_Ad)
tinyint3.5.16

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
SettingsTableName einer „Settings“-Tabelle des „dStore“ (mögliche Werte siehe Parameter „SettingsTable“)
varchar(30)3.5.16
KeyVariableEin möglicher Schlüssel, zu dem in der durch „SettingsTable“ angegebenen Tabelle ein Wert hinterlegt werden kann
varchar(50)3.5.16
DataTypeForValueVon welchem Datentyp müssen die Werte zum Schlüssel „KeyVariable“ sein
varchar(30)3.5.16
SettingsEntryCategoryIDID einer Kategorie von „Settings“-Einträgen
tinyint3.5.16
SettingsEntryCategoryBezeichnung 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
bit3.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.)
bit3.5.16
dStoreVersionSeit welcher „dStore“-Version gibt es den Schlüssel „KeyVariable“
varchar(20)3.5.16
DescriptionEine Beschreibung, wozu der Schlüssel „KeyVariable“ benötigt/verwendet wird
text3.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 5)
-569Der Benutzer hat kein Ausführungsrecht für die Prozedurnur indirekt
-567Die Prozedur darf z. Zt. nicht ausgeführt werdennur indirekt
-566Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werdennur indirekt
-535Das Datum liegt nicht in der Vergangenheitnur indirekt
-530Der Wert ist nicht konvertierbarnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-504Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochennur indirekt
-502Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)nur indirekt
-500Falsche Parameternur 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-29Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
6.5.4 2013-04-29Anpassungen an aktuellen Code-Standard
6.5.3 2013-03-18Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
4.0.10 2004-03-151. „_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-25Erstmalig 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:

cURL

Unformatierte Ausgabe:

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

Mit xmllint 6) 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>
1)
Pflichtparameter sind unterstrichen
5)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
6)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/do_getsettingsdescriptions_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)