Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:om_getsurchargetypes_ad

om_GetSurchargeTypes_Ad

Gibt im „dStore“ definierte Aufschlags-/Rabattarten zurück.

Grundsätzliches zu „Surcharges“ :

1. Der „dStore“ versteht „Surcharges“ („Aufschläge“) als Prinzip, um zusätzlich entstehende Kosten oder aber Formen von Rabatten abzubilden - diese können sowohl relativ (also prozentual) als auch absolut angegeben werden. Rabatte zeichnen sich einfach dadurch aus, daß die Kosten mit negativem Vorzeichen behaftet sind.

2. Mögliche „Surcharges“ bei der Preisermittlung für Auftrags-Positionen (→ om_GetPrices_Pu) werden aus den Tabellen „PersonSurcharges“ (für Personen) und „GroupSourcharges“ (für Gruppen) ermittelt. „Surcharges“ sind in diesem Kontext immer für bestimmte Elemente des Artikelbaums definiert, wobei diese sich immer auf die NACHFOLGER übertragen und nicht - wie bei den Artikeleigenschaften - auf die „ERBEN“ (d.h. hier wird die „Predecessor“-Spalte aus „TreeView“ herangezogen und nicht die „InheritsFrom“-Spalte) !

Es gelten hierbei folgende Prioritäten:

  • Direkt für ein Element des Artikelbaums definierte „Surcharges“ haben Vorrang vor hinterlegten „Surcharges“ zum Vorgänger-Element (analoges Prinzip zur Vererbung von Artikel-Eigenschaften).
  • „Surcharges“, die direkt einer Person zugewiesen sind, haben Vorrang vor „Surcharges“, die für eine Gruppe, der die Person angehört, hinterlegt sind.
  • Falls für den Auftraggeber „GroupSurcharges“ in Frage kommen, und die Person in MEHREREN Gruppen ist, zu denen „Surcharges“ hinterlegt sind, wird die Gruppe mit der höchsten Priorität gewählt - das ist die Gruppe mit der kleinsten „SortNo“ in der Rückgabemenge von pm_GetGroups_Ad mit entsprechend angegebener „PersonID“.

3. Es gibt seit Version 6.0.2 auch das Konzept von „Surcharges“ für einen gesamten Warenkorb bzw. Auftrag (→ om_GetTrolleySurcharges_Pu, om_GetOrderSurcharges_Ad). Dabei handelt es sich um Dinge wie Versandkosten, Skonti, Guthabenverrechnung oder ein (Gesamt-)Auftrags-Rabatt. Letzterer kann zwar auch in den meisten Fällen als Rabatt für alle Auftrags-Positionen abgebildet werden (s. 2.), aber bei absoluten Rabatten ist dies steuerlich nicht korrekt, falls unterschiedliche Steuersätze im Auftrag vorkommen !

HTTP-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategorieorder management
Engine-TypDaten-Ermittlung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
LanguageID0 ID einer Sprache, in der die Bezeichnung der Aufschlags-/Rabattart übersetzt werden soll (→ Rückgabespalte „TranslatedDescription“)
tinyint3.5.0
SurchargeTypeCategoryIDNULL ID einer Kategorie von Rabatt-/Aufschlagsarten. Angeben, um nur die Aufschlags-/Rabattarrten dieser Kategorie zu erhalen.
tinyint6.0.2

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
SurchargeTypeIDID einer Preis-Aufschlags/Rabatt-Art, wie z.B. „Versandkosten“, „Rabatt“, „Nachnahmegebühr“ o.ä.
smallint3.5.0
SurchargeTypeDescriptionBezeichnung der „SurchargeTypeID“
varchar(100)3.5.0
TranslatedDescriptionÜbersetzung von „SurchargeTypeDescription“ in der durch „LanguageID“ angegebenen Sprache („NULL“, falls keine Übersetzung existiert)
varchar(100)3.5.0
RelativeRedundante Information (s. „IsAbsoluteValue“), aufgrund der Abwärtskompatibilität beibehalten. Gibt an, ob „Surcharge“-Werte absolut („0“) oder relativ/prozentual („1“) zu verstehen sind.
bit3.5.0
BruttoRedundante Information (s. „IsAbsoluteValue“), aufgrund der Abwärtskompatibilität beibehalten. Gibt an, ob absolute „Surcharge“-Werte (nur relevant im Fall „Relative = 1“ also) Netto („0“) oder Brutto („1“) zu verstehen sind.
bit3.5.0
UnitIDID einer Währungs-Einheit (wenn „IsAbsoluteValue > 0“) oder der Prozent-Einheit (wenn „IsAbsoluteValue = 0“ ist) - also die Einheit, in der die konkreten Rabatte/Aufschläge (wie z.B. in „PersonSurcharges“) zu verstehen sind
tinyint3.5.0
UnitSymbolSymbol (im Regelfall der ISO-Code) der Einheit „UnitID“
varchar(10)3.5.0
SurchargeTypeCategoryIDID einer Kategorie von „Surcharges“, der „SurchargeTypeID“ zugeordnet ist Anmerkung : Es ist eine 1:1-Zuordnung, d.h. die „SurchargeTypeID“ muß einer Kategorie zugeordnet sein, sie kann aber auch nicht mehreren Kategorien zugeordnet sein !
tinyint6.0.2
CategoryDescriptionBezeichnung von „SurchargeTypeCategoryID“
varchar(100)6.0.2
CategoryPriorityNoGibt die Priorität der Kategorie „SurchargeTypeCategoryID“ innerhalb aller Kategorien an. Eine kleinere „PriorityNo“ bedeutet, daß „Surcharges“ dieser Kategorie früher angewendet werden. Besonderheit : „0“ bedeutet, daß die Kategorie ignoriert wird.
tinyint6.0.2
IsAbsoluteValueFasst „Relative“ und „Brutto“ in einer Einstellung zusammen, wie die Werte also zu verstehen sind :
- „0“ : relativ (prozentual)
- „1“ : absolute Netto-Werte
- „2“ : absolute Brutto-Werte
tinyint6.0.2
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • SurchargeTypeID (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 5)
-569Der Benutzer hat kein Ausführungsrecht für die Prozedurnur indirekt
-567Die Prozedur darf z. Zt. nicht ausgeführt werdennur indirekt
-566Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werdennur indirekt
-535Das Datum liegt nicht in der Vergangenheitnur indirekt
-530Der Wert ist nicht konvertierbarnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-504Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochennur indirekt
-500Falsche Parameternur 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-29Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
6.0.2 2011-06-08Holger Wies / Stefan Goebel : 1. Anpassungen aufgrund diverser Änderungen an der Tabelle „SurchargeTypes“
2. Neue Rückgabespalten aufgrund der neuen „SurchargeTypeCategories“
3. Neuer Parameter „SurchargeTypeCategoryID“
4.0.14 2004-06-031. Aufruf der Prozeduren „_mi_StartProcedure“ und „_mi_FinishProcedure“
2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
3.5.0 2000-11-23Erstmalig 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:

cURL

Unformatierte Ausgabe:

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

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetSurchargeTypes_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_GetSurchargeTypes_Ad',
		array(
			// 'LanguageID' => 0,
			// 'SurchargeTypeCategoryID' => 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_GetSurchargeTypes_Ad">
			<Parameters>
				<!-- <Parameter Name="LanguageID">0</Parameter> -->
				<!-- <Parameter Name="SurchargeTypeCategoryID">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
6)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/om_getsurchargetypes_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)