Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

@@ Zeile 1: / Zeile 1: @@
+===== do_GetProcResSortConditions_Ad =====
+Gibt Bedingungen für eine Prozedur-Rückgabemenge zurück, unter denen diese Rückgabemenge sortiert wird oder sortiert werden kann (s. a. [[dstoreproc>do_GetSortOrderForResultSet_Ad]]).\\
+Die Rückgabemenge sieht so aus :\\
+     * SortConditionID               integer        -> ID einer Sortierungs-Bedingung für die (durch "ProcedureName" und
+                                                     "ProcedureResultConditionID" referenzierte) Rückgabemenge
+     * ConditionDescription          varchar(100)   -> Bezeichnung der Bedingung "SortConditionID"
+     * ParameterName                 varchar(50)    -> Name eines Parameters der Prozedur "ProcedureName", dessen Wert beim Aufruf
+                                                     der Prozedur die Bedingung "Condition" erfüllen muß, um eine entsprechende\\                                                      Sortierung der Rückgabemenge zu liefern
+     * Condition                     varchar(255)   -> Bedingung, die der Parameter "ParameterName" der Prozedur "ProcedureName"
+                                                     beim Aufruf erfüllen muß, damit die Rückgabemenge entsprechend sortiert wird\\
+Sortiert wird aufsteigend nach "ConditionDescription und "ParameterName".\\
+|HTTP-Method|GET |
+|HTTP-Auth|Optional |
+|Alias|do_GetProcedureResultSortingConditions_Ad |
+|Tags|{{tag>[do Get Procedure Result Sorting Conditions Ad]}}|
+|Engine-Kategorie|documentation |
+|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 ^
+|__ProcedureName__| |Name einer Prozedur, die unter der in "ProcedureResultConditionID" angegebenen Bedingung eine Rückgabemenge liefert, zu der evtl. dokumentierte Sortierungen (dieser Rückgabe) ermittelt werden sollen\\ |varchar(50)|7.0.3|
+|__ProcedureResultConditionID__| |ID einer Bedingung (mögliche Werte s. [[dstoreproc>do_GetProcResultConditions_Ad]]), unter der "ProcedureName" eine Rückgabemenge liefert, zu der evtl. dokumentierte Sortierungen (dieser Rückgabe) ermittelt werden sollen\\ |integer|7.0.3|
+|SortConditionID|NULL |ID einer Sortierungs-Bedingung. Falls angegeben, werden nur die genauen Bedingungen dieser Sortierung für die durch "ProcedureName" und "ProcedureResultConditionID" angegebene Rückgabemenge ermittelt.\\ |integer|7.0.3|
+==== Rückgabe ====
+=== (parameterunabhängig) ===
+^Spaltenname  ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^
+|SortConditionID|ID einer Sortierungs-Bedingung für die (durch "ProcedureName" und "ProcedureResultConditionID" referenzierte) Rückgabemenge. Falls angegeben, natürlich identisch mit "SortConditionID".\\ |integer|7.0.3 |
+|ConditionDescription|Bezeichnung der Sortierungs-Bedingung "SortConditionID"\\ |varchar(100)|7.0.3 |
+|ParameterName|Name eines Parameters der Prozedur "ProcedureName", dessen Wert beim Aufruf die Bedingung "Condition" erfüllen muß, damit die Rückgabemenge wie zu "SortConditionID" hinterlegt (s. [[dstoreproc>do_GetSortOrderForResultSet_Ad]]) sortiert wird\\ |varchar(50)|7.0.3 |
+|Condition|Bedingung, die der Wert des Parameters "ParameterName" beim Aufruf der Prozedur erfüllen muß, damit die Rückgabemenge wie zu "SortConditionID" hinterlegt (s. [[dstoreproc>do_GetSortOrderForResultSet_Ad]]) sortiert wird\\ |varchar(255)|7.0.3 |
+== Sortierung der Rückgabe ==
+(parameterunabängige Sortierung)
+  * ConditionDescription (aufsteigend)
+  * ParameterName (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|direkt und 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.4 |2014-03-19|Kleiner interner Doku-Fehler behoben\\  |
+|7.0.3 |2013-12-13|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=do_GetProcResSortConditions_Ad|do_GetProcResSortConditions_Ad im Engine Playground öffnen]]
+== cURL ==
+Unformatierte Ausgabe:
+<code bash>
+curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/do_GetProcResSortConditions_Ad?ProcedureName=<value>&ProcedureResultConditionID=<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/do_GetProcResSortConditions_Ad?ProcedureName=<value>&ProcedureResultConditionID=<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'),
+	'do_GetProcResSortConditions_Ad',
+		array(
+			'ProcedureName' => '<value>',
+			'ProcedureResultConditionID' => <value>,
+			// 'SortConditionID' => NULL
+		)
+);
+$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="do_GetProcResSortConditions_Ad">
+			<Parameters>
+				<Parameter Name="ProcedureName"><!-- varchar value --></Parameter>
+				<Parameter Name="ProcedureResultConditionID"><!-- integer value --></Parameter>
+				<!-- <Parameter Name="SortConditionID">NULL</Parameter> -->
+			</Parameters>
+		</Procedure>
+	</Batch>
+</ListOfBatches></code>

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Unterschiede

Seiten-Werkzeuge