ac_GetCommandSettings_Ad [dstore]

Inhaltsverzeichnis

ac_GetCommandSettings_Ad

ac_GetCommandSettings_Ad

Liefert Datensätze aus „CommandSettings“ zurück - dort sind Einstellungen zu Kommandos (bzw. „Programmen“) hinterlegt, mit denen „Actions“ abegearbeitet werden können.

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

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
CommandID	NULL	ID eines Kommandos (bzw. Programms) mit dem „Actions“ abgearbeitet werden können (mögliche Werte : s. ac_GetCommands_Ad). Falls angegeben, werden nur Einstellungen zu diesem Kommando ermittelt.	smallint	5.5.0
KeyVariable	NULL	Ein Schlüssel (z.B. „ForumIDForActionLog“), zu dem der (zu „CommandID“ oder zu allen Kommandos jeweils) hinterlegte Wert ermittelt werden soll. Mögliche Werte : siehe Rückgabemenge von „ do_GetSettingsDescriptions_Ad 'CommandSettings' “.	varchar(100)	5.5.0

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
CommandID	ID eines Kommandos (bzw. Programms), mit dem „Actions“ abgearbeitet werden können	smallint	5.5.0
KeyVariable	Ein Schlüssel (z.B. „ForumIDForActionLog“). Mögliche Werte : siehe Rückgabemenge von „ do_GetSettingsDescriptions_Ad 'CommandSettings' “.	varchar(100)	5.5.0
Value	Der für „CommandID“ zum Schlüssel „KeyVariable“ konfigurierte Wert	varchar(255)	5.5.0

Sortierung der Rückgabe

(parameterunabängige Sortierung)

CommandID (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.3	2013-03-18	Interne Anpassungen wg. UTF8-Unterstützung
5.5.0	2008-01-07	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:

ac_GetCommandSettings_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/ac_GetCommandSettings_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'),
	'ac_GetCommandSettings_Ad',
		array(
			// 'CommandID' => NULL,
			// 'KeyVariable' => 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="ac_GetCommandSettings_Ad">
			<Parameters>
				<!-- <Parameter Name="CommandID">NULL</Parameter> -->
				<!-- <Parameter Name="KeyVariable">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