om_GetVoucherTypeSurcharges_Ad [dstore]

Inhaltsverzeichnis

om_GetVoucherTypeSurcharges_Ad

om_GetVoucherTypeSurcharges_Ad

Liefert zu einer Gutschein-Aktion die konfigurierten Rabatte (allgemein „Surcharges“, also auch prinzipiell Aufschläge, die aber bei Gutschein-Aktionen nicht erlaubt sind).

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[om, Get, Voucher, Type, Surcharges, 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
VoucherTypeID		ID einer Gutschein-Aktion, zu der die konfigurierten Rabatte (allgemein „Surcharges“, aber bei Gutschein-Aktionen sind derzeit keine Aufschläge erlaubt) ermittelt werden sollen. Gibt man „NULL“ an, werden „VoucherTypeID“s in „tempdb.dbo.OneID“ erwartet.	smallint	6.0.2
SurchargeTypeID	NULL	ID einer Aufschlags-/Rabattart (wie z.B. „Gutschein-Rabatt“). Falls angegeben, werden nur Konfigurationen mit dieser Aufschlags-/Rabattart berücksichtigt.	smallint	6.0.2

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
VoucherTypeID	ID einer Gutschein-Aktion	smallint	6.0.2
VoucherTypeDescription	Die Bezeichnung der Aktion „VoucherTypeID“	varchar(100)	6.0.2
SurchargeTypeID	ID einer Aufschlags- bzw. Rabattart, die für „VoucherTypeID“ hinterlegt ist	tinyint	6.0.2
SurchargeTypeDescription	Die Bezeichnung der Aufschlags- bzw. Rabattart „SurchargeTypeID“	varchar(100)	6.0.2
SurchargeValue	Der zur Gutschein-Aktion hinterlegte Rabatt (z.Zt. sind keine Aufschläge erlaubt, s. om_ModifyVoucherTypeSurch_Ad), d.h. hier steht immer ein negativer Wert (Rabatte sind „Surcharges“ mit negativem Wert)	decimal(16,6)	6.0.2
SurchargeIsAbsoluteValue	Gibt an, was für eine Angabe „SurchargeValue“ ist : „0“ : Relativer (d.h. prozentualer) Wert „1“ : Absolute Währungs-Angabe (in der zur „SurchargeTypeID“ konfigurierten Einheit), und zwar ein NETTO-Wert „2“ : Wie „1“ nur als BRUTTO-Wert zu verstehen	tinyint	6.0.3
SurchargeTypeCategoryID	ID der Kategorie, der „SurchargeTypeID“ zugeordnet ist	tinyint	6.0.2
CategoryDescription	Die Bezeichnung der Kategorie „SurchargeTypeCategoryID“	varchar(100)	6.0.2

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-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
-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
-500	Falsche Parameter	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.4	2014-03-19	Kleine Kosmetik-Korrektur : Bei einigen Code-Zeilen war am Ende ein CR-Zeichen, was wir entfernt haben
6.0.3	2011-09-07	Ergebnismenge um „SurchargeIsAbsoluteValue“ erweitert
6.0.2	2011-06-08	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_GetVoucherTypeSurcharges_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetVoucherTypeSurcharges_Ad?VoucherTypeID=<value>'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetVoucherTypeSurcharges_Ad?VoucherTypeID=<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_GetVoucherTypeSurcharges_Ad',
		array(
			'VoucherTypeID' => <value>,
			// 'SurchargeTypeID' => 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_GetVoucherTypeSurcharges_Ad">
			<Parameters>
				<Parameter Name="VoucherTypeID"><!-- smallint value --></Parameter>
				<!-- <Parameter Name="SurchargeTypeID">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