om_GetOrders_Pu [dstore]

Inhaltsverzeichnis

om_GetOrders_Pu

om_GetOrders_Pu

Gibt im „dStore“ gespeicherte Aufträge (bzw. einen Auftrag) einer bestimmten Person zurück.

Hinweis zu den Preis-Informationen einer Auftrags-Position („…ContentSum“-Rückgabespalten) :
Um herauszufinden, WIE ein Positions-Preis zustande kam, d.h. welches Artikel-Merkmal den Preis bestimmt hat, welcher Steuersatz herangezogen wurde, ob und welche Art von Rabatt - und in welche Höhe - gewährt wurde etc., gibt es entsprechende interne (von der Engine automatisch gepflegte) „OrderContentInformation“ (s. om_GetOrderContentInfo_Pu) - zu erkennen an einer negativen „InformationTypeID“ (s. om_GetOrderContentInfoTypes_Ad).

Anmerkung zum Parameter „DateAndTimeFormat“ :
Die Möglichkeiten für diesen Parameter sind exakt die, die der ASE in der Funktion „convert“ für Datums-Formatierungen bietet (in Klammern ist das Format angegeben, um in der Jahreszahl das Jahrhundert angezeigt zu bekommen) :

(0 or 100) : mon dd yyyy hh:mm AM (or PM)

1 (101) : mm/dd/yy
2 : yy.mm.dd
3 (103) : dd/mm/yy
4 (104) : dd.mm.yy
5 (105) : dd-mm-yy
6 (106) : dd mon yy
7 (107) : mon dd, yy
8 (108) : hh:mm:ss

(9 or 109) : mon dd yyyy hh:mm:sss AM (or PM)

10 (110) : mm-dd-yy
11 (111) : yy/mm/dd
12 (112) : yymmdd

Wird ein Wert aus der Menge {0,8,9,100,108,109} angegeben, bedeutet dies, das bereits eine Uhrzeit enthalten ist (bei „8“ oder „108“ ist es sogar NUR die Uhrzeit), daher wird in diesem Fall „IncludeTime“ ignoriert bzw. quasi immer mit „0“ angenommen !

Anmerkung zu den Parametern „InformationTypeID“ und „Information“ :
Da man auch einem Neukunden, der noch keine Kundennummer hat (welche aber im Regelfall für die Identifizierung benötigt wird), den Status seines Auftrags präsentieren möchte, wird statt der üblichen Personen-Identifizierung quasi eine „Auftrags-Identifizierung“ (durch besagte Parameter) durchgeführt. Dazu muß natürlich zum Auftrag eine entsprechende Information hinterlegt sein, die über alle Aufträge hinweg eindeutig ist. (Sollte durch diese Parameter kein Auftrag oder mehrere Aufträge gefunden werden, gibt es daher einen Fehler.)

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[om, Get, Orders, Pu]
Engine-Kategorie	order management
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.5 (2014-05-26)

Parameter

PersonIdentificationValues		Liste (durch '¶' getrennt) von Werten, die den Auftraggeber identifizieren. Diese Werte müssen Eigenschaften zu den Merkmal-IDs sein, die in „PersonTypeSettings“ zur „PersonTypeID“ zum Schlüssel „PersonIdentificationIDs“ hinterlegt sind.	varchar(255)	3.5.0
PersonTypeID		ID des Personen-Typs dem die zu identifizierende Person angehört. Dieser muß bei einer Identifizierung immer mit angegeben werden, da die Merkmale zur Identifizierung pro Personentyp variieren können.	tinyint	3.5.0
DateAndTimeFormat	104	Gibt an, wie „OrderDateAndTime“ und „DeliveryDateAndTime“ in der Rückgabemenge formatiert sein sollen. Der Parameter wird für die „style“-Option der ASE-Funktion „convert“ verwendet (siehe Beschreibung).	tinyint	3.5.0
IncludeTime	1	Gibt an, ob „OrderDateAndTime“ und „DeliveryDateAndTime“ in der Rückgabemenge zusätzlich eine Uhrzeit (Format „17:42:59“) enthalten sollen („0“ : Nein, „1“ : Ja). Wird ignoriert, wenn „DateAndTimeFormat“ bereits die Uhrzeit liefert !	bit	3.5.0
FromDate	NULL	Wird nur beachtet, wenn kein bestimmter Auftrag angezeigt werden soll ! Falls angegeben, werden nur Aufträge beachtet, die NACH diesem Zeitpunkt erstellt wurden. Bei „NULL“ wählt die Prozedur automatisch den aktuellen Zeitpunkt minus 24 Stunden.	datetime	3.5.0
ToDate	NULL	Wird nur beachtet, wenn kein bestimmter Auftrag angezeigt werden soll ! Falls angegeben, werden nur Aufträge berücksichtigt, die VOR diesem Zeitpunkt erstellt wurden. Bei „NULL“ wählt die Prozedur automatisch den aktuellen Zeitpunkt.	datetime	3.5.0
OrderStateList	NULL	Wird nur beachtet, wenn kein bestimmter Auftrag angezeigt werden soll ! Liste von IDs (durch '¶' getrennt) von Auftrags-(Positions-)Status, nach denen gefiltert werden soll (siehe „SkipOHavingDifferentOStates“).	varchar(250)	3.5.0
SkipOHavingDifferentOStates	1	Wird nur beachtet, wenn kein best. Auftrag angezeigt werden soll und „OrderStateList“ nicht leer ist ! Es werden dann nur Aufträge beachtet, bei denen… „0“ : MINDESTENS eine Position „1“ : ALLE Positionen … in einem der angegeb. Status ist (sind).	bit	3.5.0
OrderID	NULL	ID eines Auftrags (siehe auch „InformationTypeID“ und „Information“). Wird hierfür ein Wert übergeben, berücksichtigt die Prozedur NICHT die Parameter „FromDate“, „ToDate“, „OrderStateList“, „SkipOHavingDifferentOStates“ und „Rowcount“ !	integer	3.5.0
Rowcount	255	Wird nur beachtet, wenn kein bestimmter Auftrag angezeigt werden soll ! Beschränkt die Anzahl Datensätze der Rückgabemenge („0“ angeben, um alle Datensätze zu erhalten).	integer	3.5.0
CaseSensitive	1	„0“ : Der Vergleich der Identifizierungsdaten erfolgt unabhängig von der Groß- und Kleinschreibung „1“ : Die Identifizierungsdaten werden EXAKT verglichen	bit	3.5.0
IncludeItemNo	0	Wird nur beachtet, wenn ein best. Auftrag angezeigt werden soll ! Gibt an, ob eine Artikelnummer (Eigenschaft zum Merkmal mit der ID „6“) zur jeweiligen Auftragsposition ermittelt werden soll (→ Rückgabespalte „ItemNo“) oder nicht („0“ : Nein, „1“ : Ja).	bit	3.5.5
OrderDesc	0	Wird nur beachtet, wenn kein bestimmter Auftrag angezeigt werden soll ! „0“ : Sortierung der Rückgabemenge AUFsteigend nach dem Auftragsdatum „1“ : Sortierung der Rückgabemenge ABsteigend nach dem Auftragsdatum	bit	3.5.7
InformationTypeID	NULL	ID eines Informations-Typs (für Aufträge), auf das sich „Information“ bezieht	smallint	3.5.7
Information	NULL	Die Information, die einen bestimmten Auftrag eindeutig identifiziert (eine Art „Order-Code“). Zusammen mit „InformationTypeID“ ist dies eine Alternative zur Angabe von „PersonIdentificationValues“, „PersonTypeID und „OrderID“.	varchar(1000)	3.5.7
NodeCharacteristicID	NULL	ID eines Merkmals. Wird nur beachtet, wenn ein bestimmter Auftrag angezeigt werden soll ! Wenn hier eine ID übergeben wird, ermittelt die Prozedur zur jeweiligen Auftragsposition die Eigenschaft zu diesem Merkmal (→ Rückgabespalte „ItemProperty“).	smallint	3.5.13
LanguageID	NULL	ID einer Sprache, in der die öffentliche Beschreibung des „OrderState“ (Beschreibung des Status einer Auftragsposition, s. Rückgabemenge) ausgegeben werden soll. Wenn keine Übersetzung vorhanden ist, wird immer die Standard-Sprache gewählt.	tinyint	5.1.0
PurchaseOrder	0	Wird nur beachtet, wenn NICHT genau 1 Auftrag ausgegeben werden soll ! Gibt an, ob entweder nur Kunden-Aufträge („0“) oder nur Einkaufs-Aufträge („1“) beachtet werden sollen. (Bei letzteren haben die „OrderID“s und „OrderContentID“s negative Vorzeichen.)	bit	5.1.7

Rückgabe

wenn GetACertainOrder (Pseudo-Parameter) = 0

Spaltenname	Beschreibung	SQL-Datentyp¹⁾	ab Version
OrderDateAndTime_datetime²⁾	Wird nicht ausgegeben, sondern nur zur Sortierung verwendet - da „OrderDateAndTime“ als „String“ ausgegeben wird und ein alphanumerische Sortierung nach einem Datums-String nicht sinnvoll ist	datetime	5.0.1
LastEditedFromUserID³⁾	Ist in Version 4.0.12 durch „LastEditedByUserID“ ersetzt worden !	smallint	3.5.0
OrderID	ID eines Auftrags	integer	3.5.0
OrderNo	Auftragsnummer (aus einem Fremdsystem, falls zurück gemeldet) - falls nicht vorhanden (also „NULL“) wird hier die „OrderID“ (als „string“) ausgegeben	varchar(50)	3.5.0
OrderDateAndTime	Eingangsdatum der Bestellung als String im Format „DateAndTimeFormat“ (siehe Beschreibung). Falls „IncludeTime = 1“, dann ist zusätzlich die Uhrzeit (Format '17:42:22') angegeben.	varchar(30)	3.5.0
PersonID	ID der identifizierten Person, die den Auftrag „OrderID“ aufgegeben hat	integer	3.5.0
CustomerCharacteristicValue1	IMMER „NULL“ ! Diese Rückgabespalte dient lediglich der Vereinheitlichung der Ergebnismengen diverser Prozeduren (wie z.B. mit om_GetOrders_Ad) !	varchar(100)	5.0.1
CharacVal1RestrByPattern	IMMER „NULL“ ! Diese Rückgabespalte dient lediglich der Vereinheitlichung der Ergebnismengen diverser Prozeduren (wie z.B. mit om_GetOrders_Ad) !	varchar(100)	6.5.4
CustomerCharacteristicValue2	IMMER „NULL“ ! Diese Rückgabespalte dient lediglich der Vereinheitlichung der Ergebnismengen diverser Prozeduren (wie z.B. mit om_GetOrders_Ad) !	varchar(100)	5.0.1
CharacVal2RestrByPattern	IMMER „NULL“ ! Diese Rückgabespalte dient lediglich der Vereinheitlichung der Ergebnismengen diverser Prozeduren (wie z.B. mit om_GetOrders_Ad) !	varchar(100)	6.5.4
DeliveryPersonID	ID der Person, an die die Ware geliefert werden soll	integer	3.5.0
ShippingTypeID	ID einer Versandart für den Auftrag	tinyint	3.5.0
ShippingTypeDescription	Bezeichnung der Versandart „ShippingTypeID“	varchar(100)	5.1.6
ShippingCost	Evtl. anfallende Kosten (immer netto !) in der durch „CurrencyID“ angegebenen Währung für die Versandart „ShippingTypeID“. NICHT MEHR VERWENDEN, wird zukünftig durch „NetShippingCost“ ersetzt !	money	3.5.0
NetShippingCost	Netto-Versandkosten (entspricht „ShippingCost“)	money	5.0.1
GrossShippingCost	Brutto-Summe aller „OrderSurcharges“ der Kategorie „Versandkosten“ (ID „3“)	money	6.0.2
PreciseNetShippingCost	Exakter (intern gespeicherter) Netto-Betrag für die Versandkosten „NetShippingCost“	decimal(16,4)	5.0.1
PaymentTypeID	ID einer Zahlungsart für den Auftrag	smallint	3.5.0
PaymentTypeDescription	Bezeichnung der Abrechnungsart „PaymentTypeID“	varchar(100)	5.1.6
PaymentCost	Evtl. anfallende Kosten (immer netto !) in der durch „CurrencyID“ angegebenen Währung für die Zahlungsart „PaymentTypeID“. NICHT MEHR VERWENDEN, wird zukünftig durch „NetPaymentCost“ ersetzt !	money	3.5.0
NetPaymentCost	Netto-Betrag für die Abrechnungsart-Kosten (entspricht „PaymentCost“)	money	5.0.1
GrossPaymentCost	Brutto-Summe aller „OrderSurcharges“ der Kategorie „Zahlungskosten“ (ID „4“)	money	6.0.2
PreciseNetPaymentCost	Exakter (intern gespeicherter) Netto-Betrag für die Abrechnungsart-Kosten „NetPaymentCost“	decimal(16,4)	5.0.1
NettoSum	Netto-Betrag (in der durch „CurrencyID“ angegebenen Währung) für den Auftrag „OrderID“ (Englischer Spaltenname ist NICHT korrekt, NICHT mehr verwenden !)	money	3.5.0
NetSum	Netto-Betrag der Bestellung „OrderID“	money	5.0.1
PreciseNetSum	Exakter (intern gespeicherter) Wert für „NetSum“	decimal(16,4)	5.0.1
BruttoSum	Brutto-Betrag (in der durch „CurrencyID“ angegebenen Währung) für den Auftrag „OrderID“ (Englischer Spaltenname ist NICHT korrekt, NICHT mehr verwenden !)	money	3.5.0
GrossSum	Brutto-Betrag der Bestellung „OrderID“	money	5.0.1
PreciseGrossSum	Exakter (intern gespeicherter) Wert für „GrossSum“	decimal(16,4)	5.0.1
CurrencyID	ID der Währung, die der Auftraggeber gewählt hat und in der sämtliche Währungsangaben sind	tinyint	3.5.0
UnitSymbol	Symbol (im Regelfall der ISO-Code) der Einheit „CurrencyID“	varchar(10)	3.5.0
LastEditedByUserID	ID des „dStore“-Benutzers (der in „UserInfo“ registriert ist) der den Auftrag zuletzt bearbeitet hat. Wird z.Zt. nur gepflegt beim Anlegen eines Auftrags und beim Ändern d. Auftraggebers durch om_AcknowledgeOrders_Ad.	smallint	4.0.12
PersonTypeID	ID des Personen-Typs von „PersonID“. Die Rückgabespalte ist für DIESE Prozedur eigentlich überflüssig, da hier immer der Wert von „PersonTypeID“ steht. Hintergrund ist, daß hier wie auch in om_GetOrders_Ad die gleiche interne Prozedur verwendet wird.	tinyint	3.5.0
PositionCount	Wieviele Positionen enthält der Auftrag „OrderID“	smallint	3.5.0
OrderStateID	ID des Status, den alle Auftragsspositionen aktuell haben, oder „NULL“, falls die Positionen unterschiedliche Status besitzen	tinyint	3.5.0
DeliveryDateAndTime	Vom Auftraggeber gewünschter Liefertermin als String im Format „DateAndTimeFormat“ (siehe Beschreibung). Falls „IncludeTime = 1“, dann ist zusätzlich die Uhrzeit (Format '17:42:22') angegeben.	varchar(30)	3.5.0
OrderState	Bezeichnung des Status „OrderStateID“ - falls vorhanden, wird hier die Übersetzung in der „LanguageID“ ausgegeben	varchar(50)	3.5.6
PublicDescription	Beschreibung des Status „OrderStateID“ für den Kunden	varchar(255)	3.5.6

Sortierungen der Rückgabe

wenn OrderDesc = 0

OrderDateAndTime_datetime (aufsteigend)

wenn OrderDesc = 1

OrderDateAndTime_datetime (absteigend)

wenn GetACertainOrder (Pseudo-Parameter) = 1

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
OrderID	ID des Auftrags, der durch „InformationTypeID“ und „Information“ eindeutig identifiziert wurde oder „OrderID“	integer	3.5.0
OrderNo	Auftragsnummer (aus einem Fremdsystem, falls zurück gemeldet) - falls nicht vorhanden (also „NULL“) wird hier die „OrderID“ (als „string“) ausgegeben	varchar(50)	3.5.0
PersonID	ID der identifizierten Person, die den Auftrag „OrderID“ aufgegeben hat	integer	3.5.0
CustomerCharacteristicValue1	IMMER „NULL“ ! Diese Rückgabespalte dient lediglich der Vereinheitlichung der Ergebnismengen diverser Prozeduren (wie z.B. mit om_GetOrders_Ad) !	varchar(100)	5.0.1
CharacVal1RestrByPattern	IMMER „NULL“ ! Diese Rückgabespalte dient lediglich der Vereinheitlichung der Ergebnismengen diverser Prozeduren (wie z.B. mit om_GetOrders_Ad) !	varchar(100)	6.5.4
CustomerCharacteristicValue2	IMMER „NULL“ ! Diese Rückgabespalte dient lediglich der Vereinheitlichung der Ergebnismengen diverser Prozeduren (wie z.B. mit om_GetOrders_Ad) !	varchar(100)	5.0.1
CharacVal2RestrByPattern	IMMER „NULL“ ! Diese Rückgabespalte dient lediglich der Vereinheitlichung der Ergebnismengen diverser Prozeduren (wie z.B. mit om_GetOrders_Ad) !	varchar(100)	6.5.4
DeliveryPersonID	ID der Person, an die die Ware geliefert werden soll	integer	3.5.0
OrderDateAndTime	Eingangsdatum der Bestellung als String im Format „DateAndTimeFormat“ (siehe Beschreibung). Falls „IncludeTime = 1“, dann ist zusätzlich die Uhrzeit (Format '17:42:22') angegeben.	varchar(30)	3.5.0
OrderContentPosition	Nummer der Auftragsposition	smallint	3.5.0
NodeID	ID des Artikel-Elementes der Auftragsposition, das der Auftraggeber „PersonID“ bestellt hat	integer	3.5.0
Description	Bezeichnung der „NodeID“. Falls vorhanden, wird an dieser Stelle die Eigenschaft (des Elementes „NodeID“) zum Merkmal „Produktbezeichnung“ (in der Sprache „LanguageID“) ausgegeben.	varchar(1000)	3.5.0
Quantity	Wieviel wurde vom Artikel „NodeID“ bestellt	integer	3.5.0
NettoContentSum	Netto-Betrag (in der durch „CurrencyID“ angegebenen Währung) für die Auftragsposition (also nicht der Stückpreis des Artikels „NodeID“, sondern „Stückpreis * Quantity“ !) - Englischer Spaltenname ist NICHT korrekt, NICHT mehr verwenden !	money	3.5.0
NetContentSum	Netto-Betrag (in der durch „CurrencyID“ angegebenen Währung) für die Auftragsposition (also nicht der Stückpreis des Artikels „NodeID“, sondern „Stückpreis * Quantity“ !)	money	5.0.1
PreciseNetContentSum	Exakter (intern gespeicherter) Wert für „NetContentSum“	decimal(16,4)	5.0.1
BruttoContentSum	Brutto-Betrag (in der durch „CurrencyID“ angegebenen Währung) für die Auftragsposition (also nicht der Stückpreis des Artikels „NodeID“, sondern „Stückpreis * Quantity“ !) - Englischer Spaltenname ist NICHT korrekt, NICHT mehr verwenden !	money	3.5.0
GrossContentSum	Brutto-Betrag (in der durch „CurrencyID“ angegebenen Währung) für die Auftragsposition (also nicht der Stückpreis des Artikels „NodeID“, sondern „Stückpreis * Quantity“ !)	money	5.0.1
PreciseGrossContentSum	Exakter (intern gespeicherter) Wert für „GrossContentSum“	decimal(16,4)	5.0.1
NettoOrderSum	Netto-Betrag (in der durch „CurrencyID“ angegebenen Währung) für den Auftrag - Englischer Spaltenname ist NICHT korrekt, NICHT mehr verwenden !	money	3.5.0
NetOrderSum	Netto-Betrag (in der durch „CurrencyID“ angegebenen Währung) für den Auftrag	money	5.0.1
PreciseNetOrderSum	Exakter (intern gespeicherter) Wert für „NetOrderSum“	decimal(16,4)	5.0.1
BruttoOrderSum	Brutto-Betrag (in der durch „CurrencyID“ angegebenen Währung) für den Auftrag - Englischer Spaltenname ist NICHT korrekt, NICHT mehr verwenden !	money	3.5.0
GrossOrderSum	Brutto-Betrag (in der durch „CurrencyID“ angegebenen Währung) für den Auftrag	money	5.0.1
PreciseGrossOrderSum	Exakter (intern gespeicherter) Wert für „GrossOrderSum“	decimal(16,4)	5.0.1
OrderStateID	ID des Status der Bestellposition „OrderContentID“	tinyint	3.5.0
ShippingTypeID	ID einer Versandart für den Auftrag	tinyint	3.5.0
ShippingTypeDescription	Bezeichnung der Versandart „ShippingTypeID“	varchar(100)	5.0.2
ShippingCost	Evtl. anfallende Kosten (immer netto !) in der durch „CurrencyID“ angegebenen Währung für die Versandart „ShippingTypeID“. NICHT MEHR VERWENDEN, wird zukünftig durch „NetShippingCost“ ersetzt !	money	3.5.0
NetShippingCost	Evtl. anfallende (Netto-)Kosten (in der durch „CurrencyID“ angegebenen Währung) für die Versandart „ShippingTypeID“	money	5.0.1
GrossShippingCost	Brutto-Summe aller „OrderSurcharges“ der Kategorie „Versandkosten“ (ID „3“)	money	6.0.2
PreciseNetShippingCost	Exakter (intern gespeicherter) Netto-Betrag für die Versandkosten „NetShippingCost“	decimal(16,4)	5.0.1
PaymentTypeID	ID einer Zahlungsart für den Auftrag	smallint	3.5.0
PaymentTypeDescription	Bezeichnung der Abrechnungsart „PaymentTypeID“	varchar(100)	5.0.2
PaymentCost	Evtl. anfallende Kosten (immer netto !) in der durch „CurrencyID“ angegebenen Währung für die Zahlungsart „PaymentTypeID“. NICHT MEHR VERWENDEN, wird zukünftig durch „NetPaymentCost“ ersetzt !	money	3.5.0
NetPaymentCost	Evtl. anfallende (Netto-)Kosten (in der durch „CurrencyID“ angegebenen Währung) für die Zahlungsart „PaymentTypeID“	money	5.0.1
GrossPaymentCost	Brutto-Summe aller „OrderSurcharges“ der Kategorie „Zahlungskosten“ (ID „4“)	money	6.0.2
PreciseNetPaymentCost	Exakter (intern gespeicherter) Netto-Betrag für die Abrechnungsart-Kosten „NetPaymentCost“	decimal(16,4)	5.0.1
CurrencyID	ID einer Währung, in der die Kosten „ShippingCost“, „PaymentCost“, „NettoSum“ und „BruttoSum“ angegeben sind	tinyint	3.5.0
CurrencySymbol	Symbol (im Regelfall der ISO-Code) der Einheit „CurrencyID“	varchar(10)	3.5.0
DeliveryDateAndTime	Vom Auftraggeber gewünschter Liefertermin als String im Format „DateAndTimeFormat“ (siehe Beschreibung). Falls „IncludeTime = 1“, dann ist zusätzlich die Uhrzeit (Format '17:42:22') angegeben.	varchar(30)	3.5.0
OrderContentID	ID der Auftragsposition	integer	3.5.7
OrderContentNo	Nummer der Bestellung eines Fremdsystems, in das die Position exportiert wurde. Immer „NULL“ falls „OrderNo“ NICHT „NULL“ ist !	varchar(50)	5.0.2
OrderContentWasModified	Wurde die Position „OrderContentID“ nachträglich geändert ? („0“ : Nein, „1“ : Ja) Anmerkung : Eine Änderung der „OrderNo“ wird übrigens NICHT berücksichtigt !	bit	5.0.2
ItemNo	Eigenschaft des Artikel-Elementes „NodeID“ zum Merkmal mit der ID „6“ (also die Artikelnummer). Immer „NULL“, wenn „IncludeItemNo = 0“ ist !	varchar(1000)	3.5.5
OrderState	Bezeichnung des Status „OrderStateID“ - falls vorhanden, wird hier die Übersetzung in der „LanguageID“ ausgegeben	varchar(50)	3.5.6
PublicDescription	Beschreibung des Status „OrderStateID“ für den Kunden	varchar(255)	3.5.6
ItemProperty	Eigenschaft des Artikel-Elementes „NodeID“ zum Merkmal „NodeCharacteristicID“ (wenn „NULL“ für „NodeCharacteristicID“ angegeben wurde, steht hier auch „NULL“)	varchar(1000)	3.5.11

Sortierung der Rückgabe

(parameterunabängige Sortierung)

OrderContentPosition (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-660	Identifikation fehlgeschlagen	nur indirekt
-621	Fehlender oder falscher Eintrag in PersonTypeSettings	nur indirekt
-599	Lizenz ist ungültig oder abgelaufen	nur indirekt
-550	Fehlender oder falscher Eintrag in Settings	nur indirekt
-530	Der Wert ist nicht konvertierbar	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	nur indirekt
-374	Aufgrund der angegebenen Information konnte kein Auftrag gefunden werden	nur direkt
-371	Die angegebene Information gehört nicht eindeutig zu einem bestimmten Auftrag	nur direkt
-286	Der Benutzer hat nicht die Berechtigung(en), Eigenschaften zu diesem(n) Merkmal(en) zu lesen/ändern	nur indirekt
-284	Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu modifizieren	nur indirekt
-283	Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu ermitteln	nur indirekt
-220	Es konnte keine Merkmal-ID für die Produktbezeichnung ermittelt werden	nur indirekt

XML-Schema

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

Historie

7.0.5	2014-05-26	Datentyp des Parameters „Information“ erweitert
7.0.1	2013-08-07	1. Datentyp der Rückgabespalten „Description“, „ItemNo“ und „ItemProperty“ hat sich erweitert ⇒ Anpassung der Doku 2. Anpassungen an den aktuellen Quellcode-Standard
6.5.4	2013-04-29	Neue Rückgabespalten „CharacVal…RestrByPattern“ [wg. „Zugriffsbeschränkungen“], die aber immer „NULL“ sind
6.0.2	2011-06-08	Neue Rückgabespalten „GrossPaymentCost“ und „GrossShippingCost“
5.1.7	2006-10-31	Neuer Parameter „PurchaseOrder“
5.1.6	2006-09-14	Neue Rückgabespalten „ShippingTypeDescription“ und „PaymentTypeDescription“ bei unbekannter „OrderID“
5.1.0	2006-02-08	Neuer Parameter „LanguageID“
5.0.2	2005-04-29	1. Neue Rückgabespalten „ShippingTypeDescription“, „PaymentTypeDescription“, „OrderContentNo“ und „OrderContentWasModified“ falls ein bestimmter Auftrag ausgegeben wird 2. Präzisierung der Doku für die Rückgabespalte „OrderNo“ [in beiden Ergebnismengen]
5.0.1	2005-03-29	1. Viele neue Rückgabespalten 2. Änderung des Datentyps von „OrderStateList“ 3. „NULL“ oder ein Wert “< 0„ für „Rowcount“ gibt jetzt “-500„ 4. Überarbeitung der Doku
5.0.0	2004-12-21	1. Differenzierung, falls durch „InformationTypeID“ plus „Information“ nicht eindeutig ein Auftrag identifiziert werden kann ⇒ neuer Returncode “-374„ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
4.0.12	2004-04-30	1. Div. interne Änderungen 2. Änderungen bzgl. „IncludeTime“ u. „LastEditedFromUserID“
3.5.16	2002-04-25
3.5.13	2001-12-06
3.5.7	2001-05-04
3.5.6	2001-04-17
3.5.5	2001-03-30
3.5.4	2001-03-11
3.5.0	2000-11-23	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_GetOrders_Pu im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetOrders_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetOrders_Pu?PersonIdentificationValues=<value>&PersonTypeID=<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_GetOrders_Pu',
		array(
			'PersonIdentificationValues' => '<value>',
			'PersonTypeID' => <value>,
			// 'DateAndTimeFormat' => 104,
			// 'IncludeTime' => 1,
			// 'FromDate' => NULL,
			// 'ToDate' => NULL,
			// 'OrderStateList' => NULL,
			// 'SkipOHavingDifferentOStates' => 1,
			// 'OrderID' => NULL,
			// 'Rowcount' => 255,
			// 'CaseSensitive' => 1,
			// 'IncludeItemNo' => 0,
			// 'OrderDesc' => 0,
			// 'InformationTypeID' => NULL,
			// 'Information' => NULL,
			// 'NodeCharacteristicID' => NULL,
			// 'LanguageID' => NULL,
			// 'PurchaseOrder' => 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_GetOrders_Pu">
			<Parameters>
				<Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter>
				<Parameter Name="PersonTypeID"><!-- tinyint value --></Parameter>
				<!-- <Parameter Name="DateAndTimeFormat">104</Parameter> -->
				<!-- <Parameter Name="IncludeTime">1</Parameter> -->
				<!-- <Parameter Name="FromDate">NULL</Parameter> -->
				<!-- <Parameter Name="ToDate">NULL</Parameter> -->
				<!-- <Parameter Name="OrderStateList">NULL</Parameter> -->
				<!-- <Parameter Name="SkipOHavingDifferentOStates">1</Parameter> -->
				<!-- <Parameter Name="OrderID">NULL</Parameter> -->
				<!-- <Parameter Name="Rowcount">255</Parameter> -->
				<!-- <Parameter Name="CaseSensitive">1</Parameter> -->
				<!-- <Parameter Name="IncludeItemNo">0</Parameter> -->
				<!-- <Parameter Name="OrderDesc">0</Parameter> -->
				<!-- <Parameter Name="InformationTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="Information">NULL</Parameter> -->
				<!-- <Parameter Name="NodeCharacteristicID">NULL</Parameter> -->
				<!-- <Parameter Name="LanguageID">NULL</Parameter> -->
				<!-- <Parameter Name="PurchaseOrder">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

²⁾ , ³⁾

Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.

⁵⁾

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