om_ModifyPurchaseOrderQueue_Ad [dstore]

Inhaltsverzeichnis

om_ModifyPurchaseOrderQueue_Ad

om_ModifyPurchaseOrderQueue_Ad

Fügt Artikel-Elemente in eine „Einkaufs-Auftrags-Queue“, bzw. löscht oder aktualisiert Positionen einer solchen „Queue“.

Bei der „Einkaufs-Auftrags-Queue“ handelt es sich um das Pendant zum „Warenkorb“, der ebenfalls als „Queue“ angesehen werden kann - nur eben für Kunden-Aufträge.

Eine „Einkaufs-Auftrags-Queue“ ist eindeutig durch…

einen Lieferanten („SupplierID“),
einen Auftrags-Typ („OrderTypeID“) und
einen Zeitpunkt, an dem der Auftrag spätestens beim Lieferanten platziert werden muß (die sogenannte „OrderDeadline“)

… bestimmt.

Eine solche „Queue“ enthält dann (wie auch der „Warenkorb“) einzelne Artikel-Positionen (eindeutig durch „HTreeNodeID“s gekennzeichnet), die bestellt werden sollen.
Hinweis : In „PurchaseOrderQueues“ werden letztlich IMMER „HTreeNodeID“s gespeichert, d.h. im Fall „IsTreeNodeOrHTreeNodeID IN (0,1)“ wird die jeweils (aktuell) zugehörige „HTreeNodeID“ zur in „NodeOrTreeNodeOrHTreeNodeID“ angegebenen ID automatisch ermittelt.

Allgemeine Hinweise :
1. Ist das Element „NodeOrTreeNodeOrHTreeNodeID“ für den Benutzer, der diese Prozedur aufruft, gesperrt, gibt es einen entsprechenden Fehler - ausgenommen im „Löschen-Fall“ („DeletePosition = 1“ bzw. „DeleteQueue = 1“) !
2. „OrderDeadline“ muß in der Zukunft liegen, denn es macht wenig Sinn eine neue „Queue“ zu öffnen oder eine vorhandene „Queue“ zu bearbeiten, deren „OrderDeadline“ bereits abgelaufen ist. Solche „Queues“ können nur gelöscht werden (→ „DeletePosition“ bzw. „DeleteQueue“).
3. Ein gelöschtes Element darf (außer im FAll „DeletePosition = 1“) NICHT übergeben werden (sonst „-500“) !
4. Ist nach der Aktualisierung der „Quantity“-Wert gleich „0“ (kann nur im Fall „RelativeChange = 1“ auftreten, s.a. Anmerkung zu diesem Parameter), wird das Element automatisch aus der „Queue“ entfernt.

Anmerkung zum Parameter „NetSum“ :

Die Einheit der Preis-Angabe im Parameter „NetSum“ bestimmt sich automatisch durch das zum Lieferanten hinterlegte „Einkaufs-Preis“-Merkmal (s. om_GetSupplierConfigurations_Ad) - sollte diese Einstellung jedoch NICHT vorhanden sein, gibt es einen Fehler !

Anmerkungen zum Parameter „RelativeChange“ :

1. Im Fall „RelativeChange = 0“ ist in „Quantity“ bzw. „NetSum“ NUR ein Wert ECHT GRÖSSER als „0“ erlaubt.
2. Gibt es in der Queue das Element „NodeOrTreeNodeOrHTreeNodeID“ schon, wird der „Quantity“- bzw. „NetSum“-Wert im Fall „RelativeChange = 0“ überschrieben, ansonsten wird der Wert jeweils HINZU-addiert - insbesondere kann ein NEGATIVER Wert übergeben werden, um z.B. die Menge („Quantity“) zu VERRINGERN !
3. Ist „RelativeChange = 1“ und kommt das Element „NodeOrTreeNodeOrHTreeNodeID“ NEU in die „Auftrags-Queue“ hinzu, MUSS der „Quantity“- bzw. „NetSum“-Wert ECHT GRÖSSER als „0“ sein !

Anmerkungen zum Parameter „ChangeOrderDeadlineTo“ :

1. Wenn es die „Queue“ nicht gibt, oder bereits eine „Queue“ mit „SupplierID“, „OrderTypeID“ und „ChangeOrderDeadlineTo“ existiert, erhält man den Fehler „-500“ !
2. Der Zeitpunkt „ChangeOrderDeadlineTo“ muß in der Zukunft liegen (sonst „-500“) !
3. In der „Comment“-Spalte wird der Text '„OrderDeadline“ changed ! ' vorangestellt, um diese Änderung auf jeden Fall zu dokumentieren. Wenn die Spalte vorher mehr als 229 Zeichen enthielt, werden daher natürlich einige Zeichen nach der Änderung fehlen !

HTTP-Method	POST
HTTP-Auth	Optional
Tags	[om, Modify, Purchase, Order, Queue, Ad]
Engine-Kategorie	order management
Engine-Typ	Daten-Änderung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
SupplierID		ID eines Lieferanten, bei dem bestellt werden soll (also eine „PersonID“)	integer	5.1.9
OrderTypeID		ID eines Auftrag-Typs. Mögliche Werte : siehe om_GetPurchaseOrderTypes_Ad.	tinyint	5.1.9
OrderDeadline		Zusammen mit den Parametern „SupplierID“ und „OrderTypeID“ ist hierdurch eindeutig die zu bearbeitende „Queue“ gekennzeichnet. Gibt den Zeitpunkt an, zu dem die zu dieser „Queue“ gehörenden Artikel spätestens beim Lieferanten zu bestellen sind.	datetime	5.1.9
NodeOrTreeNodeOrHTreeNodeID		Je nach „IsTreeNodeOrHTreeNodeID“ die ID eines Artikel-Elementes („NodeID“) oder eines Elementes im Artikelbaum („TreeNodeID“) oder eines Elementes im Artikelbaum mit einem Gültigkeitszeitraum („HTreeNodeID“). (Letztlich also eine Position der „Queue“)	integer	5.1.9
IsTreeNodeOrHTreeNodeID	0	Um was handelt es sich bei „NodeOrTreeNodeOrHTreeNodeID“ : „0“ : „NodeID“ „1“ : „TreeNodeID“ „2“ : „HTreeNodeID“	tinyint	5.1.9
Quantity		Wieviel vom Artikel „NodeOrTreeNodeOrHTreeNodeID“ der „Queue“ bestellt/hinzugefügt (je nach „RelativeChange“) werden soll. Ist „RelativeChange = 1“, kann hier ein negativer Wert stehen, wenn der Artikel in der „Queue“ bereits existiert.	integer	5.1.9
NetSum		Der fällige Gesamt-Netto-Preis für den Artikel, wenn er in der durch „Quantity“ angegebenen Menge bestellt wird. Im Fall „RelativeChange = 1“ kann hier auch ein negativer Wert stehen, wenn der Artikel schon in der „Queue“ existiert.	money	5.1.9
Comment	NULL	Optionaler Kommentar zur Artikel-Position „NodeOrTreeNodeOrHTreeNodeID“, z.B. so etwas wie „Telefonische Preis-Absprache mit Hr. X vom …„	varchar(255)	5.1.9
RelativeChange	0	„0“ : Der Artikel soll genau mit den Werten „Quantity“ und „NetSum“ in der „Queue“ stehen „1“ : Die Werte „Quantity“ und „NetSum“ sind der (bestehenden) Artikel-Position HINZU zu addieren (s. Beschreibung !)	bit	5.1.9
DeletePosition	0	„1“ angeben, um die durch „NodeOrTreeNodeOrHTreeNodeID“ angegebene Artikel-Position zu löschen. ACHTUNG : In diesem Fall muß „NodeOrTreeNodeOrHTreeNodeID“ eine „HTreeNodeID“ sein !	bit	5.1.9
DeleteQueue	0	Wird nur beachtet, wenn „NULL“ für „ChangeOrderDeadlineTo“ angegeben ist ! Möchte man die durch „SupplierID“, „OrderTypeID“ und „OrderDeadline“ eindeutig referenzierte „Queue“ komplett löschen, gibt man hier „1“ an.	bit	5.1.9
ChangeOrderDeadlineTo	NULL	Um nur die „OrderDeadline“ der durch „SupplierID“, „OrderTypeID“ und „OrderDeadline“ eindeutig referenzierten „Queue“ zu ändern, gibt man ein entsprechendes Datum in „ChangeOrderDeadlineTo“ an - ALLE anderen Parameter werden dann ignoriert !	datetime	5.1.9

Rückgabe

Die Prozedur hat keine Rückgaben.

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁴⁾
-661	Die Person besitzt keine oder eine ungültige Eigenschaft zu einem bestimmten Merkmal	nur indirekt
-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
-502	Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)	nur indirekt
-500	Falsche Parameter	direkt und indirekt
-120	Der Benutzer hat keine Berechtigung für das (die) Element(e)	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	Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
6.5.4	2013-04-29	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
5.1.9	2007-01-26	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_ModifyPurchaseOrderQueue_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifyPurchaseOrderQueue_Ad?SupplierID=<value>&OrderTypeID=<value>&OrderDeadline=<value>&NodeOrTreeNodeOrHTreeNodeID=<value>&Quantity=<value>&NetSum=<value>'

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifyPurchaseOrderQueue_Ad?SupplierID=<value>&OrderTypeID=<value>&OrderDeadline=<value>&NodeOrTreeNodeOrHTreeNodeID=<value>&Quantity=<value>&NetSum=<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_ModifyPurchaseOrderQueue_Ad',
		array(
			'SupplierID' => <value>,
			'OrderTypeID' => <value>,
			'OrderDeadline' => <value>,
			'NodeOrTreeNodeOrHTreeNodeID' => <value>,
			'Quantity' => <value>,
			'NetSum' => <value>,
			// 'IsTreeNodeOrHTreeNodeID' => 0,
			// 'Comment' => NULL,
			// 'RelativeChange' => 0,
			// 'DeletePosition' => 0,
			// 'DeleteQueue' => 0,
			// 'ChangeOrderDeadlineTo' => 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_ModifyPurchaseOrderQueue_Ad">
			<Parameters>
				<Parameter Name="SupplierID"><!-- integer value --></Parameter>
				<Parameter Name="OrderTypeID"><!-- tinyint value --></Parameter>
				<Parameter Name="OrderDeadline"><!-- datetime value --></Parameter>
				<Parameter Name="NodeOrTreeNodeOrHTreeNodeID"><!-- integer value --></Parameter>
				<Parameter Name="Quantity"><!-- integer value --></Parameter>
				<Parameter Name="NetSum"><!-- money value --></Parameter>
				<!-- <Parameter Name="IsTreeNodeOrHTreeNodeID">0</Parameter> -->
				<!-- <Parameter Name="Comment">NULL</Parameter> -->
				<!-- <Parameter Name="RelativeChange">0</Parameter> -->
				<!-- <Parameter Name="DeletePosition">0</Parameter> -->
				<!-- <Parameter Name="DeleteQueue">0</Parameter> -->
				<!-- <Parameter Name="ChangeOrderDeadlineTo">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