om_GetPurchaseOrderQueues_Ad [dstore]

Inhaltsverzeichnis

om_GetPurchaseOrderQueues_Ad

om_GetPurchaseOrderQueues_Ad

Gibt sogenannte „Einkaufs-Auftrags-Queues“ aus. Dabei 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 : Um eine „Queue“ auch tatsächlich in einen Auftrag zu wandeln, ist die Prozedur om_CopyFromPOQueueToOrder_Ad zu verwenden.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[om, Get, Purchase, Order, Queues, 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
SupplierID	NULL	Wird nur beachtet, wenn „GetSummaryOnly = 0“ ist ! ID eines Lieferanten, bei dem bestellt werden soll (also eine „PersonID“). Falls angegeben, werden nur „Queues“ dieses Lieferanten ermittelt.	integer	5.1.9
FromOrderDeadline	NULL	Wird nur beachtet, wenn „GetSummaryOnly = 0“ ist ! Falls angegeben, werden nur „Queues“ ermittelt, deren jeweilige „Deadline“ (s. Rückgabespalte „OrderDeadline“) HINTER (der Wert selbst eingeschlossen) diesem Zeitpunkt liegt.	datetime	5.1.9
ToOrderDeadline	NULL	Wird nur beachtet, wenn „GetSummaryOnly = 0“ ist und ein Wert für „FromOrderDeadline“ angegeben wurde ! Falls angegeben, werden nur „Queues“ ermittelt, deren jeweilige „Deadline“ VOR (der Wert selbst eingeschlossen) diesem Zeitpunkt liegt.	datetime	5.1.9
OrderTypeID	NULL	Wird nur beachtet, wenn „GetSummaryOnly = 0“ ist ! ID eines Auftrag-Typs (mögliche Werte : s. om_GetPurchaseOrderTypes_Ad). Falls angegeben, werden nur „Queues“ ermittelt, die diesem Auftrags-Typ angehören.	tinyint	5.1.9
NodeID	NULL	Wird nur beachtet, wenn „GetSummaryOnly = 0“ ist ! ID eines Artikel-Elementes. Falls angegeben, werden nur „Queues“ ausgegeben (aber immer komplett !), die eine Position mit diesem Element besitzen.	integer	5.1.9
GetSummaryOnly	0	Bestimmt die Rückgabemenge : „0“ : Man erhält eine DETAILLIERTE Ergebnismenge „1“ : Man erhält eine Zusammenfassung über alles „Queues“ „2“ : Man erhält eine Zusammenfassung der „Queues“ pro Lieferant	tinyint	5.1.9
NodeCharacteristicID	NULL	Wird nur beachtet, wenn „GetSummaryOnly = 0“ ist ! ID eines Artikel-Merkmals. Wenn hier eine ID übergeben wird, ermittelt die Prozedur zur jeweiligen „Queue“-Position die Eigenschaft zu diesem Merkmal (→ Rückgabespalte „ItemProperty“).	smallint	5.1.9

Rückgabe

wenn GetSummaryOnly = 0

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
SupplierID	ID eines Lierferanten, bei dem bestellt werden soll (also eine „PersonID“)	integer	5.1.9
SupplierCharacteristicValue1	Eigenschaft von „SupplierID“ zum Merkmal mit der 1. ID, die in „PersonTypSettings“ zu „PersonOutputCharacteristics“ (zum entsprechenden Typ) konfiguriert und nicht für den Aufrufer komplett lesend gesperrt (s. pm_GetPChAccRestrForUsers_Ad) ist	varchar(100)	5.1.9
SupplCharacVal1RestrByPattern	Was enthält „SupplCharacVal1RestrByPattern“ (womögl. wg. Zugriffsbeschr. nur einen Teil) ? - NULL : den vollst. Wert - „#left(<n>)#“ : die ERSTEN n Zeich. - „#right(<n>)#“ : die LETZTEN n Zeich. („n = 0“ ⇒ „SupplCharacVal1RestrByPattern“ dann „NULL“)	varchar(100)	6.5.4
SupplierCharacteristicValue2	Eigenschaft von „SupplierID“ zum Merkmal mit der 2. ID, die in „PersonTypSettings“ zu „PersonOutputCharacteristics“ (zum entsprechenden Typ) konfiguriert und nicht für den Aufrufer komplett lesend gesperrt (s. pm_GetPChAccRestrForUsers_Ad) ist	varchar(100)	5.1.9
SupplCharacVal2RestrByPattern	Wie „SupplCharacVal1RestrByPattern“ - nur eben auf „SupplierCharacteristicValue2“ bezogen	varchar(100)	6.5.4
OrderTypeID	ID eines Auftrag-Typs (z.B. „Vor-Order“ oder Ähnliches). Dient dazu, die „Queues“ bzw. die daraus resultierenden Aufträge zu „charakterisieren“.	tinyint	5.1.9
OrderTypeDescription	Bezeichnung des Auftrag-Typs „OrderTypeID“	varchar(100)	5.1.9
OrderDeadline	Zeitpunkt, an dem der Artikel „NodeID“ spätestens beim Lieferanten „SupplierID“ bestellt werden muß. Gibt also den Zeitpunkt an, wann aus der „Queue“ spätestens ein Auftrag gemacht werden muß.	datetime	5.1.9
HTreeNodeID	ID des Elementes aus „HistoryTreeView“ (in dieser ist die Historie des gesamten Artikelbaums abgebildet), das den mit „NodeDescription“ bezeichneten Artikel „NodeID“ EINDEUTIG macht	integer	5.1.9
NodeID	ID des zur „HTreeNodeID“ zugehörigen Artikel-Elementes	integer	5.1.9
TreeNodeID	ID des zur „HTreeNodeID“ zugehörigen Elementes im Artikelbaum (, das „NodeID“ als Artikel-Element zugewiesen hat)	integer	5.1.9
NodeDescription	Bezeichnung des Artikel-Elementes „NodeID“	varchar(100)	5.1.9
ItemNo	Eigenschaft des Artikel-Elementes „NodeID“ zum Merkmal mit der ID „6“ (also die Artikelnummer)	varchar(1000)	5.1.9
ItemProperty	Eigenschaft des Artikel-Elementes „NodeID“ zum Merkmal „NodeCharacteristicID“ (wenn „NULL“ für „NodeCharacteristicID“ angegeben wurde, steht hier auch „NULL“)	varchar(1000)	5.1.9
Quantity	Wieviel vom Artikel „NodeID“ bestellt werden soll	integer	5.1.9
NetSum	Gesamt-Netto-Preis (in der durch „CurrencyID“ angegebenen Währung), wenn der Artikel „NodeID“ beim Lieferanten „SupplierID“ bis spätestens „OrderDeadline“ in der Menge „Quantity“ bestellt wird	money	5.1.9
CurrencyID	ID der Währung, in der „NetSum“ angegeben ist	tinyint	5.1.9
CurrencySymbol	Symbol (im Regelfall der ISO-Code) der Einheit „CurrencyID“	varchar(10)	5.1.9
Comment	Optionaler Kommentar, der zur Artikel-Position „NodeID“ in der Queue hinterlegt wurde (z.B. so etwas wie „Telefonische Preis-Absprache mit Hr. X vom …“)	varchar(255)	5.1.9
CreatedByUserID	ID des dStore-Benutzers (der in „UserInfo“ registriert ist), der die Position „NodeID“ der Queue hinzufügt hat	smallint	5.1.9
CreatedByUserName	Name des Benutzers „CreatedByUserID“	varchar(50)	5.1.9
CreatedAtDateAndTime	Wann wurde die Position „NodeID“ der „Queue“ hinzugefügt	datetime	5.1.9
LastEditedByUserID	ID des dStore-Benutzers (der in „UserInfo“ registriert ist), der die Position „NodeID“ zuletzt bearbeitet hat	smallint	5.1.9
LastEditedByUserName	Name des Benutzers „LastEditedByUserID“	varchar(50)	5.1.9
LastEditedAtDateAndTime	Wann wurde die Position „NodeID“ der Queue zuletzt bearbeitet	datetime	5.1.9

Sortierung der Rückgabe

(parameterunabängige Sortierung)

SupplierID (aufsteigend)
OrderTypeID (aufsteigend)
OrderDeadline (aufsteigend)
NodeDescription (aufsteigend)

wenn GetSummaryOnly = 1

Spaltenname	Beschreibung	SQL-Datentyp⁵⁾	ab Version
NumberOfQueues	Wieviele „Queues“ gibt es insgesamt	integer	5.1.9
NumberOfSuppliers	Bei wieviel VERSCHIEDENEN Lieferanten existieren „Queues“	integer	5.1.9
NumberOfItems	Wieviel VERSCHIEDENE Artikel („NodeID“s) sind insgesamt in allen existierenden „Queues“	integer	5.1.9
MinOrderDeadline	Was ist die nächste (also kleinste in der Zukunft liegende) „OrderDeadline“	money	5.1.9
MaxOrderDeadline	Was ist die letzte (also größte in der Zukunft liegende) „OrderDeadline“	money	5.1.9
NumberOfExpiredDeadlines	Bei wievielen „Queues“ wurde die „OrderDeadline“ schon überschritten	integer	5.1.9

wenn GetSummaryOnly = 2

Spaltenname	Beschreibung	SQL-Datentyp⁶⁾	ab Version
SupplierID	ID eines Lierferanten, bei dem bestellt werden soll (also eine „PersonID“)	integer	5.1.9
SupplierCharacteristicValue1	Eigenschaft von „SupplierID“ zum Merkmal mit der 1. ID, die in „PersonTypSettings“ zu „PersonOutputCharacteristics“ (zum entsprechenden Typ) konfiguriert und nicht für den Aufrufer komplett lesend gesperrt (s. pm_GetPChAccRestrForUsers_Ad) ist	varchar(100)	5.1.9
SupplCharacVal1RestrByPattern	Was enthält „SupplCharacVal1RestrByPattern“ (womögl. wg. Zugriffsbeschr. nur einen Teil) ? - NULL : den vollst. Wert - „#left(<n>)#“ : die ERSTEN n Zeich. - „#right(<n>)#“ : die LETZTEN n Zeich. („n = 0“ ⇒ „SupplCharacVal1RestrByPattern“ dann „NULL“)	varchar(100)	6.5.4
SupplierCharacteristicValue2	Eigenschaft von „SupplierID“ zum Merkmal mit der 2. ID, die in „PersonTypSettings“ zu „PersonOutputCharacteristics“ (zum entsprechenden Typ) konfiguriert und nicht für den Aufrufer komplett lesend gesperrt (s. pm_GetPChAccRestrForUsers_Ad) ist	varchar(100)	5.1.9
SupplCharacVal2RestrByPattern	Wie „SupplCharacVal1RestrByPattern“ - nur eben auf „SupplierCharacteristicValue2“ bezogen	varchar(100)	6.5.4
NumberOfQueues	Wieviele „Queues“ beim Lieferanten „SupplierID“ gibt es	integer	5.1.9
NumberOfItems	Wieviel VERSCHIEDENE Artikel („NodeID“s) sind insgesamt in allen existierenden „Queues“ beim Lieferanten „SupplierID“	integer	5.1.9
TotalQuantity	Gesamt-Menge aller Artikel aller „Queues“ beim Lieferanten „SupplierID“	integer	5.1.9
TotalNetSum	Gesamt-Netto-Summe (in der durch „CurrencyID“ angegebenen Währung) aller Positionen aller „Queues“ beim Lieferanten „SupplierID“	money	5.1.9
CurrencyID	ID der Währung, in der „TotalNetSum“ angegeben ist	tinyint	5.1.9
CurrencySymbol	Symbol (im Regelfall der ISO-Code) der Einheit „CurrencyID“	varchar(10)	5.1.9
PurchasePriceCharacteristicID	ID des Artikel-Merkmals, zu dem die Einkaufs-Preise (sprich „Einkaufspreis“-Eigenschaften von Artikel-Elementen) des Lieferanten hinterlegt sind	smallint	5.1.9
MinOrderDeadline	Was ist die nächste (also kleinste in der Zukunft liegende) „OrderDeadline“ beim Lieferanten „SupplierID“	datetime	5.1.9
MaxOrderDeadline	Was ist die letzte (also größte in der Zukunft liegende) „OrderDeadline“ beim Lieferanten „SupplierID“	datetime	5.1.9
NumberOfExpiredDeadlines	Bei wievielen „Queues“ des Lieferanten „SupplierID“ wurde die „OrderDeadline“ schon überschritten	integer	5.1.9

Sortierung der Rückgabe

(parameterunabängige Sortierung)

SupplierID (aufsteigend)

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	direkt und indirekt
-500	Falsche Parameter	direkt und indirekt
-283	Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu ermitteln	nur 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]
7.0.1	2013-08-07	Datentyp der Rückgabespalten „ItemNo“ und „ItemProperty“ hat sich erweitert ⇒ Auch Anpassung der Doku
6.5.4	2013-04-29	1. Beachtung der neuen Zugriffs-Beschränkungen für Merkmale [⇒ Doku-Anpassung Rückgabespalten „SupplierCharacteristicValue…“] 2. Zwei neue „SupplCharacVal…RestrByPattern“-Rückgabespalten [wg. des neuen features „Zugriffsbeschränkung“]
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_GetPurchaseOrderQueues_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁸⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetPurchaseOrderQueues_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_GetPurchaseOrderQueues_Ad',
		array(
			// 'SupplierID' => NULL,
			// 'FromOrderDeadline' => NULL,
			// 'ToOrderDeadline' => NULL,
			// 'OrderTypeID' => NULL,
			// 'NodeID' => NULL,
			// 'GetSummaryOnly' => 0,
			// 'NodeCharacteristicID' => 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_GetPurchaseOrderQueues_Ad">
			<Parameters>
				<!-- <Parameter Name="SupplierID">NULL</Parameter> -->
				<!-- <Parameter Name="FromOrderDeadline">NULL</Parameter> -->
				<!-- <Parameter Name="ToOrderDeadline">NULL</Parameter> -->
				<!-- <Parameter Name="OrderTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="NodeID">NULL</Parameter> -->
				<!-- <Parameter Name="GetSummaryOnly">0</Parameter> -->
				<!-- <Parameter Name="NodeCharacteristicID">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