Benutzer-Werkzeuge

Webseiten-Werkzeuge

Action disabled: source

engine:procedures:om_getallowedorderstates

om_GetAllowedOrderStates

Ermittelt, welche Status-Wechsel von Aufträgen (bzw. Auftragspositionen) der Benutzer, der diese Prozedur aufruft, vornehmen darf.

Anmerkung : Es werden grundsätzlich nur „OrderStateID“s, die kleiner als „250“ sind, ausgegeben, da alle IDs ab „250“ für interne Zwecke reserviert sind !

HTTP-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategorieorder management
Engine-TypDaten-Ermittlung
Letzte Aktualisierung5.1.3 (2006-07-27)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
FromOrderStateIDNULL ID eines Auftrags-Status (besser : Status einer Auftrags-Position !). Wenn angegeben, ermittelt die Prozedur alle Status, in die der Benutzer, der diese Prozedur aufruft, VON diesem Status wechseln darf.
tinyint3.5.6
ToOrderStateIDNULL ID eines Auftrags-Status (besser : Status einer Auftrags-Position !). Wenn angegeben, ermittelt die Prozedur alle Status, von denen der Benutzer, der diese Prozedur aufruft, IN diesem Status wechseln darf.
tinyint3.5.6
PaymentForShippingIDNULL ID einer Zahlungsart-Versandart-Kombination, nach der optional gefiltert werden kann. Hintergrund : Ob ein Wechsel von einem Status in einen anderen vorgenommen werden darf, kann von der Zahlungsart-Versandart-Kombination abhängen.
smallint3.5.6
LanguageIDNULL ID einer Sprache, in der die öffentliche Beschreibung („PublicDescription“) der Zahlungs- und Versandart ausgegeben werden soll. Wenn keine Übersetzung vorhanden ist, wird immer die Standard-Sprache gewählt.
tinyint3.5.15
OnlyActive0 Sollen nur aktive Status berücksichtigt werden ? („0“ : Nein, „1“ : Ja)
bit3.5.21

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
FromOrderStateIDID eines Auftrags(-Positions)-Status. Der Benutzer, der diese Prozedur aufruft, darf von diesem Status in den Status „ToOrderStateID“ wechseln - wenn als Zahlungs-/Versandart des Auftrags „PaymentTypeID“ bzw. „ShippingTypeID“ hinterlegt ist.
tinyint3.5.6
FromOrderStateBezeichnung des Status „FromOrderStateID“
varchar(50)3.5.6
FromPublicDescriptionÖffentliche Beschreibung des Status „FromOrderStateID“ (in der durch „LanguageID“ angegebenen Sprache bzw. in der Standardsprache)
varchar(255)3.5.6
ToOrderStateIDID eines Auftrags(-Positions)-Status. Der Benutzer, der diese Prozedur aufruft, darf vom Status „FromOrderStateID“ in diesen Status wechseln - wenn als Zahlungs-/Versandart des Auftrags „PaymentTypeID“ bzw. „ShippingTypeID“ hinterlegt ist.
tinyint3.5.6
ToOrderStateBezeichnung des Status „ToOrderStateID“
varchar(50)3.5.6
ToPublicDescriptionÖffentliche Beschreibung des Status „ToOrderStateID“ (in der durch „LanguageID“ angegebenen Sprache bzw. in der Standardsprache)
varchar(255)3.5.6
PaymentForShippingIDID einer Zahlungsart-Versandart-Kombination, genauer der Kombination aus „PaymentTypeID“ und „ShippingTypeID“
smallint3.5.6
PaymentForShippingDescriptionBezeichnung der Zahlungsart-Versandart-Kombination „PaymentForShippingID“
varchar(100)3.5.6
PaymentTypeIDID einer Zahlungsart. Der Benutzer, der diese Prozedur aufruft, darf einen Statuswechsel von „FromOrderStateID“ nach „ToOrderStateID“ nur durchführen, wenn zum Auftrag diese Zahlungsart UND die Versandart „ShippingTypeID“ hinterlegt ist.
smallint3.5.6
ShippingTypeIDID einer Versandart. Der Benutzer, der diese Prozedur aufruft, darf einen Statuswechsel von „FromOrderStateID“ nach „ToOrderStateID“ nur durchführen, wenn zum Auftrag diese Versandart UND die Zahlungsart „PaymentTypeID“ hinterlegt ist.
tinyint3.5.6

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 5)
-621Fehlender oder falscher Eintrag in PersonTypeSettingsnur indirekt
-550Fehlender oder falscher Eintrag in Settingsnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-500Falsche Parameternur indirekt

XML-Schema

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

Historie

5.1.3 2006-07-271. Interne Umstellung, da sich eine verwendete Prozedur [„_om_GetAllowedOrderStates“] geändert hat
2. Verwendung von mi_GetSettingEntry anstatt direkt auf „Settings“ zuzugreifen
3. Fehlende „set forceplan“-Anweisung
4. Kleine Performance-Verbesserung
5.1.2 2006-06-26Berücksichtigung, daß ab 5.1.2 die „OrderStateID“s größer „249“ für interne Zwecke reserviert sind
3.5.21 2002-08-06
3.5.15 2002-03-12
3.5.6 2001-04-17Erstmalig 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/om_GetAllowedOrderStates'

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetAllowedOrderStates' | 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_GetAllowedOrderStates',
		array(
			// 'FromOrderStateID' => NULL,
			// 'ToOrderStateID' => NULL,
			// 'PaymentForShippingID' => NULL,
			// 'LanguageID' => NULL,
			// 'OnlyActive' => 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="om_GetAllowedOrderStates">
			<Parameters>
				<!-- <Parameter Name="FromOrderStateID">NULL</Parameter> -->
				<!-- <Parameter Name="ToOrderStateID">NULL</Parameter> -->
				<!-- <Parameter Name="PaymentForShippingID">NULL</Parameter> -->
				<!-- <Parameter Name="LanguageID">NULL</Parameter> -->
				<!-- <Parameter Name="OnlyActive">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
6)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/om_getallowedorderstates.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)