do_GetReturnCodes_Ad [dstore]

Inhaltsverzeichnis

do_GetReturnCodes_Ad

do_GetReturnCodes_Ad

Gibt Beschreibungen zu den im „dStore“ verwendeten Return-Codes aus.

Anmerkung zum Parameter „LanguageID“ :
Die Sprach-ID bezieht sich nicht auf die „Languages“-Tabelle, die Bestandteil der „dStore“-Kunden-Datenbank ist, denn die Sprachen könnten ja von Kunde zu Kunde verschieden sein. Daher gibt es in der „dstore“-Datenbank, in der sich u.a. die Dokumentation der Software befindet, eine zusätzliche „Languages“-Tabelle. Die hier vorhandenen Datensätze sind vorgegeben und können nur (durch do_GetdStoreLanguages_Ad) eingesehen werden.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[do, Get, 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
ReturnCode	NULL	Ein bestimmter Return-Code im „dStore“, zu dem die Beschreibung ermittelt werden soll	smallint	3.5.16
ReturnCodeCategoryID	NULL	ID einer Kategorie von Return-Codes, nach der gefiltert werden soll	tinyint	3.5.16
LanguageID	NULL	ID einer Sprache (aus der „Languages“-Tabelle der „dstore“-Datenbank !), in der die Beschreibung ausgegeben werden soll („NULL“ für die Standardsprache)	tinyint	3.5.16

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
ReturnCode	Ein Return-Code, der von „dStore“-Prozeduren oder -Triggern zurückgegeben werden kann	integer	3.5.16
Description	Kurz-Beschreibung des „ReturnCode“	varchar(100)	3.5.16
DetailedDescription	Ausführliche Beschreibung des „ReturnCode“	text	3.5.16
ReturnCodeCategoryID	ID der Kategorie, der „ReturnCode“ zugeordnet ist	tinyint	3.5.16
ReturnCodeCategory	Bezeichnung der Kategorie „ReturnCodeCategoryID“	varchar(100)	3.5.16

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
-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]
4.0.10	2004-03-15	1. Aufruf der Prozeduren „_mi_StartProcedure“ und „_mi_FinishProcedure“ 2. „set transaction isolation level 1“, „set rowcount 0“ zu Beginn d. Prozedur 3. Doku-Überarbeitung 4. Konsequente Fehlerbehandlung 5. Fehlende/falsche „optimizer“-/Index-Angaben
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_GetReturnCodes_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/do_GetReturnCodes_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_GetReturnCodes_Ad',
		array(
			// 'ReturnCode' => NULL,
			// 'ReturnCodeCategoryID' => NULL,
			// 'LanguageID' => 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_GetReturnCodes_Ad">
			<Parameters>
				<!-- <Parameter Name="ReturnCode">NULL</Parameter> -->
				<!-- <Parameter Name="ReturnCodeCategoryID">NULL</Parameter> -->
				<!-- <Parameter Name="LanguageID">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