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-Method | GET |
HTTP-Auth | Optional |
Tags | |
Engine-Kategorie | order management |
Engine-Typ | Daten-Ermittlung |
Letzte Aktualisierung | 5.1.3 (2006-07-27) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
FromOrderStateID | NULL | 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. | tinyint | 3.5.6 |
ToOrderStateID | NULL | 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. | tinyint | 3.5.6 |
PaymentForShippingID | NULL | 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. | smallint | 3.5.6 |
LanguageID | NULL | 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. | tinyint | 3.5.15 |
OnlyActive | 0 | Sollen nur aktive Status berücksichtigt werden ? („0“ : Nein, „1“ : Ja) | bit | 3.5.21 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
FromOrderStateID | ID 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. | tinyint | 3.5.6 |
FromOrderState | Bezeichnung 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 |
ToOrderStateID | ID 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. | tinyint | 3.5.6 |
ToOrderState | Bezeichnung 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 |
PaymentForShippingID | ID einer Zahlungsart-Versandart-Kombination, genauer der Kombination aus „PaymentTypeID“ und „ShippingTypeID“ | smallint | 3.5.6 |
PaymentForShippingDescription | Bezeichnung der Zahlungsart-Versandart-Kombination „PaymentForShippingID“ | varchar(100) | 3.5.6 |
PaymentTypeID | ID 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. | smallint | 3.5.6 |
ShippingTypeID | ID 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. | tinyint | 3.5.6 |
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 5) |
---|---|---|
-621 | Fehlender oder falscher Eintrag in PersonTypeSettings | nur indirekt |
-550 | Fehlender oder falscher Eintrag in Settings | nur indirekt |
-510 | Der Benutzer ist nicht registriert | nur indirekt |
-500 | Falsche Parameter | nur indirekt |
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
5.1.3 | 2006-07-27 | 1. 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-26 | Berü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-17 | Erstmalig in dieser Version erstellt |
Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
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 -
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();
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>