om_ModifyOrderStatesInCats_Ad [dstore]

Inhaltsverzeichnis

om_ModifyOrderStatesInCats_Ad

om_ModifyOrderStatesInCats_Ad

Verwaltet die Zuordnungen von Auftrags-(Positions-)Status in Kategorien.

Anmerkung :

Es gibt eine besondere Kategorie, und zwar die mit der ID „1“ („Statistikrelevant“). Wechselt ein Auftrag in einen Status dieser Kategorie, werden die Statistiken zu den Basiskennzahlen 4 bis 6 automatisch korrigiert. Entsprechend werden die Statistiken korrigiert, wenn ein Status aus dieser Kategorie entfernt wird.

Hinweis : Es ist nicht möglich, den (speziellen) Status mit der ID „0“ („nicht bearbeitet“) in die folgenden Kategorien einzuordnen :

„Statistikrelevant“ (ID „1“)
„Prepaid-Code generieren“ (ID „4“)
„Surcharge-Neuberechnung“ (ID „5“)

HTTP-Method	POST
HTTP-Auth	Optional
Alias	om_ModifyOrderStatesInCategories_Ad
Tags	[om, Modify, Order, States, In, Categories, Ad]
Engine-Kategorie	configurations
Engine-Typ	Daten-Änderung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
OrderStateCategoryID		ID einer Kategorie von Auftrags-(Positions-)Status	tinyint	3.5.21
OrderStateID		ID eines Auftrags-(Positions-)Status, der der Kategorie „OrderStateCategoryID“ zugeordnet werden soll oder bereits zugeordnet ist (und die „SortNo“ zu ändern ist, bzw. die Zuordnung gelöscht werden soll)	tinyint	3.5.21
SortNo	NULL	Bestimmt die Reihenfolge des Status „OrderStateID“ innerhalb aller Status, die der Kategorie „OrderStateCategoryID“ zugeordnet sind. Bei „NULL“ legt die Prozedur die Reihenfolge selbst fest, und zwar so, daß „OrderStateID“ an letzter Stelle steht.	tinyint	3.5.21
Delete	0	„0“ : Der Status „OrderStateID“ soll der Kategorie „OrderStateCategoryID“ zugeordnet werden bzw. die „SortNo“ ist zu ändern „1“ : Die Zuordnung „OrderStateID“ zu „OrderStateCategoryID“ soll gelöscht werden	bit	3.5.21

Rückgabe

Die Prozedur hat keine Rückgaben.

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
-503	Fehlerhafte Daten in einer Tabelle - genauere Fehlermeldung auf der Standardausgabe	nur indirekt
-500	Falsche Parameter	direkt und 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]
6.0.2	2011-06-08	Stefan Goebel : Ab jetzt gibt es einen Fehler, wenn man die spezielle „OrderStateID = 0“ in die speziellen [in 6.0.2 hinzugekommenen] Kategorien „Prepaid-Code generieren“ und „Surcharge-Neuberechnung“ einordnen möchte
6.0.0	2010-03-26	1. Man kann nun die „OrderStateID = 0“ nicht mehr der „OrderStateCategoryID = 1“ zuordnen 2. Anpassung des Quellcodes an den aktuellen Standard 3. Explizite Prüfung, ob „OrderStateCategoryID“ und „OrderStateID“ auch existieren
5.0.3	2005-06-07	Die intern verwendete Prozedur „_if_st_CorrectStatistics“ wurde durch „_if__st_CorrectStatistics“ ersetzt
5.0.2	2005-04-29	Die Schnittstelle der intern verwendeten Prozedur „_st_CorrectStatistics“ hat sich geändert
4.0.14	2004-06-03	1. Aufruf von „_mi_StartProcedure“ und „_mi_FinishProcedure“ 2. „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn 3. Konsequente Fehlerbehandlung 4. Die Aktualisierungen im Falle einer Umsortierung waren nicht in einer Transaktion
3.5.21	2002-08-06	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_ModifyOrderStatesInCats_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifyOrderStatesInCats_Ad?OrderStateCategoryID=<value>&OrderStateID=<value>'

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifyOrderStatesInCats_Ad?OrderStateCategoryID=<value>&OrderStateID=<value>' | 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_ModifyOrderStatesInCats_Ad',
		array(
			'OrderStateCategoryID' => <value>,
			'OrderStateID' => <value>,
			// 'SortNo' => NULL,
			// 'Delete' => 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_ModifyOrderStatesInCats_Ad">
			<Parameters>
				<Parameter Name="OrderStateCategoryID"><!-- tinyint value --></Parameter>
				<Parameter Name="OrderStateID"><!-- tinyint value --></Parameter>
				<!-- <Parameter Name="SortNo">NULL</Parameter> -->
				<!-- <Parameter Name="Delete">0</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