do_GetProcedureReturnCodes_Ad [dstore]

Inhaltsverzeichnis

do_GetProcedureReturnCodes_Ad

do_GetProcedureReturnCodes_Ad

Gibt alle Return-Codes aus, die während der Ausführung einer Prozedur auftreten können.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[do, Get, Procedure, Return, Codes, 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
ProcedureName	NULL	Name einer Prozedur, zu der die Return-Codes, die diese Prozedur bei der Ausführung liefern kann, ermittelt werden sollen. Bei Angabe von „NULL“ wird nur nach „ProcedureCategoryID“ bzw. „ReturnCode“ gefiltert.	varchar(50)	4.0.0
ProcedureCategoryID	NULL	ID einer Kategorie von Prozeduren (mögliche Werte : siehe do_GetProcedureCategories_Ad), zu denen die Return-Codes ermittelt werden sollenl. Ist „NULL“ angegeben, wird nur nach „ProcedureName“ bzw. „ReturnCode“ gefiltert.	tinyint	4.0.0
ReturnCode	NULL	Ein Return-Code, der von einer „dStore“-Prozedur zurückgegeben werden kann. Falls angegeben, werden nur die Prozeduren berücksichtigt, die bei der Ausführung diesen Code zurückgeben könnten.	integer	4.0.0
IncludeIndirectReturnCodes	0	Weil Prozeduren andere Prozeduren aufrufen können, wird hierdurch bestimmt, ob nur Return-Codes ermittelt werden sollen, die DIREKT („0“) auftreten können, oder ob auch INDIREKTE („1“) Codes (von intern aufgerufenen Prozeduren) zu berücksichtigen sind.	bit	4.0.0

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
ProcedureName	Name einer „dStore“-Prozedur	varchar(50)	4.0.0
ReturnCode	Ein „dStore“-Return-Code, der von der Prozedur „ProcedureName“ bei der Ausführung zurückgegeben werden kann	integer	4.0.0
ReturnCodeOccurence	Der „ReturnCode“ kann… „0“ : …direkt in der Prozedur auftreten „1“ : …nur durch eine intern aufgerufene Prozedur auftreten „2“ : …sowohl von der Prozedur selbst als auch von einer intern aufgerufenen Prozedur zurückgegeben werden	tinyint	4.0.0
Description	Kurze Erläuterung der Bedeutung des „ReturnCode“s	varchar(100)	4.0.0

Sortierung der Rückgabe

(parameterunabängige Sortierung)

ProcedureName (aufsteigend)
ReturnCode (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
5.0.4	2005-09-26	1. Fehler bzgl. der Ermittlung indirekter Return-Codes 2. Fehlerhafte Werte für „ReturnCodeOccurence“
4.0.10	2004-03-15	1. Aufruf der Prozeduren „_mi_StartProcedure“, „_mi_FinishProcedure“ und „_mi_ChooseParamValueSeperator“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur 3. Konsequente Fehlerbehandlung
4.0.0	2003-04-03	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_GetProcedureReturnCodes_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/do_GetProcedureReturnCodes_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_GetProcedureReturnCodes_Ad',
		array(
			// 'ProcedureName' => NULL,
			// 'ProcedureCategoryID' => NULL,
			// 'ReturnCode' => NULL,
			// 'IncludeIndirectReturnCodes' => 0
		)
);
 
$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_GetProcedureReturnCodes_Ad">
			<Parameters>
				<!-- <Parameter Name="ProcedureName">NULL</Parameter> -->
				<!-- <Parameter Name="ProcedureCategoryID">NULL</Parameter> -->
				<!-- <Parameter Name="ReturnCode">NULL</Parameter> -->
				<!-- <Parameter Name="IncludeIndirectReturnCodes">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