Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:mi_getreturncodemessage

mi_GetReturnCodeMessage

Gibt die Fehler-Codes im „dStore“ zurück - das sind letztlich „integer“-Werte, die von „dStore“-Prozduren zurückgegeben werden können und signalisieren, daß ein Fehler aufgetreten ist.

HTTP-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategoriemiscellaneous
Engine-TypDaten-Ermittlung
Letzte Aktualisierung5.0.4 (2005-09-26)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
ReturnCodeNULL Eine Zahl, die von einer „dStore“-Prozedur zurückgegeben werden kann und einen Fehler-Code darstellt. Optionaler Parameter, um nur den Datensatz eines bestimmten Fehler-Codes zu bekommen.
integer3.5.0
LanguageIDNULL ID einer Sprache (aus der „Languages“-Tabelle der „dstore“-Datenbank [siehe do_GetdStoreLanguages_Ad] ! ). Optionaler Parameter, um den Klartext und die Beschreibung der Fehler-Codes in einer bestimmten Sprache zurückzubekommen.
tinyint3.5.20

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
ReturnCodeEine Zahl, die von einer „dStore“-Prozedur zurückgegeben werden kann und einen Fehler-Code darstellt
integer3.5.0
DescriptionKurzer Klartext, was der Fehler-Code „ReturnCode“ zu bedeuten hat. Falls eine „LanguageID“ angegeben wurde, aber keine Übersetzung vorhanden ist, wird die Standardsprache („Deutsch“) verwendet.
varchar(100)3.5.0
DetailedDescriptionAusführlichere Beschreibung des Fehler-Codes „ReturnCode“. Falls eine „LanguageID“ angegeben wurde, aber keine Übersetzung vorhanden ist, wird die Standardsprache („Deutsch“) verwendet.
varchar(255)3.5.0
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • ReturnCode (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Die Prozedur hat keine Fehlercodes.

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

5.0.4 2005-09-26Kleine interne Änderungen
4.0.0 2003-04-031. Fehler bzgl. des kürzlich neu eingeführten Parameters „LanguageID“
2. Überarbeitung der Quelltext-Doku und der Doku
3. Verzicht auf eine temporäre Tabelle in einem Fall
3.5.20 2002-07-22
3.5.0 2000-11-23Erstmalig 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/mi_GetReturnCodeMessage'

Mit xmllint 5) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetReturnCodeMessage' | 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'),
	'mi_GetReturnCodeMessage',
		array(
			// 'ReturnCode' => 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="mi_GetReturnCodeMessage">
			<Parameters>
				<!-- <Parameter Name="ReturnCode">NULL</Parameter> -->
				<!-- <Parameter Name="LanguageID">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/mi_getreturncodemessage.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)