om_GetOrderStateDescr_Ad [dstore]

Inhaltsverzeichnis

om_GetOrderStateDescr_Ad

om_GetOrderStateDescr_Ad

Liefert die Übersetzungen der öffentliche Beschreibung eines Auftags-(Positions-)Status zurück.

Anmerkung zum Parameter „LanguageID“ :
Falls „LanguageID = 0“, wird der Paramter auf die „DefaultLanguageID“ aus „Settings“ gesetzt, so daß die Spalte „TranslatedDescription“ immer „NULL“-Werte enthält (weil „CharacteristicDescription“ immer in der „Default-Sprache“ ist) !

HTTP-Method	GET
HTTP-Auth	Optional
Alias	om_GetOrderStateDescriptions_Ad
Tags	[om, Get, Order, State, Descriptions, Ad]
Engine-Kategorie	order management
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
OrderStateID	NULL	ID eines Auftrags-(Positions-)Status. Falls angegeben, werden nur die Übersetzungen (der öffentlichen Beschreibung) dieses Status ermittelt.	tinyint	5.5.2
LanguageID	NULL	ID einer Sprache. Falls angegeben, werden nur Übersetzungen in dieser Sprache ermittelt.	tinyint	5.5.2

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
OrderStateID	ID eines Auftrags-(Positions-)Status	tinyint	5.5.2
OrderState	Bezeichnung des Status (in der Standard-Sprache, nicht übersetzbar)	varchar(50)	5.5.2
PublicDescription	Öffentliche Beschreibung des Status in der Standard-Sprache	varchar(255)	5.5.2
TranslatedDescription	Übersetzung der öffentlichen Beschreibung in der durch „LanguageID“ angegebenen Sprache. „NULL“, falls keine Übersetzung vorhanden ist.	varchar(255)	5.5.2
LanguageID	ID der Sprache, in der „TranslatedDescription“ zu verstehen ist	tinyint	5.5.2
Language	Bezeichnung der Sprache „LanguageID“	varchar(50)	5.5.2
LanguageSymbol	Internationales Symbol der Sprache „LanguageID“. Bei Neu-Installationen ab Version 5.5.2 sind die Werte gemäß „ISO 639-1“. An diesen Standard sollte man sich halten bzw. die Werte bei bestehenden Installationen anpassen !	varchar(3)	5.5.2

Sortierung der Rückgabe

(parameterunabängige Sortierung)

OrderState (aufsteigend)
LanguageID (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-621	Fehlender oder falscher Eintrag in PersonTypeSettings	nur indirekt
-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
-550	Fehlender oder falscher Eintrag in Settings	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	„_mi_FinishProcedure“-Aufruf am Schluß fehlte
5.5.2	2008-10-21	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:

om_GetOrderStateDescr_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

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