Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:om_getsurchargetypecategories

om_GetSurchargeTypeCategories

Gibt die Kategorien aus, zu denen Rabatt-/Aufschlagsarten („SurchargeTypes“ oder kurz „Surcharges“) zugeordnet werden können.

Hinweis : Die Einordnung von „Surcharges“ (Rabatte/Aufschläge) in Kategorien (1:1-Zuordnung) ist insbesondere aufgrund der „PriorityNo“ (s. gleichnamige Rückgabespalte dieser Prozedur) einer Kategorie für die Anwendung von Rabatten/Aufschlägen auf einen gesamten Warenkorb bzw. Auftrag wichtig, da sie die Reihenfolge bestimmt, in der die „Surcharges“ angewandt werden. „Surcharges“ einer Kategorie bekommen als Berechnungs-Grundlage (der Betrag, auf den der „Surcharge“ anzuwenden ist, bei relativen „Surcharges“ natürlich sehr entscheidend) nämlich immer den Warenwert plus bereits errechnete „Surcharges“ von Kategorien höherer Priorität (kleinere „PriorityNo“). Haben zwei Kategorien dieselbe Priorität, bekommen sie natürlich dieselbe Berechnungs-Grundlage.

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
CategoryIDNULL ID einer Kategorie von „SurchargeTypes“. Falls angegeben, wird nur der entsprechende Datensatz zurückgegeben.
tinyint6.0.2

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
SurchargeTypeCategoryIDID der Kategorien
tinyint6.0.2
CategoryDescriptionBezeichnung der Kategorie
varchar(100)6.0.2
PriorityNoGibt 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
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • PriorityNo (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-29„Start-/Finish-Procedure“-Logik eingebaut, s. Ticket #3670
6.0.2 2011-06-08Erstmalig 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_GetSurchargeTypeCategories'

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetSurchargeTypeCategories' | 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_GetSurchargeTypeCategories',
		array(
			// 'CategoryID' => 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_GetSurchargeTypeCategories">
			<Parameters>
				<!-- <Parameter Name="CategoryID">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_getsurchargetypecategories.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)