Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:om_getusedvouchercodes_ad

om_GetUsedVoucherCodes_Ad

Gibt die „benutzten“ - d.h. eingelösten oder zumindest erfolgreich validierten - Gutschein-Codes (aus der Tabelle „VoucherCodes“) aus.

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
VisitorOrOrderID ID eines Besuchers („IsOrderID = 0“) oder Auftrags („IsOrderID = 1“), zu dem alle validierten bzw. eingelösten Codes ermittelt werden sollen. Falls angegeben, muß auch „IsOrderID“ angegeben sein. Wenn „NULL“, muß „VoucherCode“ angegeben werden !
integer6.0.2
IsOrderID Wird nur beachtet, wenn „VisitorOrOrderID“ angegeben ist (und muß dann auch angegeben werden). Gibt an, ob „VisitorOrOrderID“ die ID eines Besuchers („0“) oder Auftrags („1“) ist.
tinyint6.0.2
VoucherCodeNULL Ein konkreter Gutschein-Code, für den kontrolliert werden soll, ob und wenn ja durch wen er schon validiert bzw. eingelöst wurde. Pflicht-Angabe falls „NULL“ für „VisitorOrOrderID“ übergeben wird !
varchar(50)6.0.2
FromValidationDateAndTimeNULL Falls angegeben werden nur Validierungen bzw. (bei Aufträgen sind es :) Einlösungen ermittelt, die NACH diesem Zeitpunkt stattfanden
datetime6.0.2
ToValidationDateAndTimeNULL Falls angegeben werden nur Validierungen bzw. (bei Aufträgen sind es :) Einlösungen ermittelt, die VOR diesem Zeitpunkt stattfanden
datetime6.0.2

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
VisitorOrOrderIDID eines Warenkorbs (wenn „IsOrderID = 0“) oder Auftrags (wenn „IsOrderID = 1“)
integer6.0.2
IsOrderIDGibt an, ob es sich bei „VisitorOrOrderID“ um einen Warenkorb („0“ oder Auftrag („1“) handelt
tinyint6.0.2
VoucherCodeEin Gutschein-Code, der im Auftrag „VisitorOrOrderID“ eingelöst (falls „IsOrderID = 1“) oder zum Warenkorb hinterlegt (wenn „IsOrderID = 0“) wurde
varchar(50)6.0.2
LastValidationDateAndTimeDer Zeitpunkt der letzten (erfolgreichen) Validierung des Codes
datetime6.0.2
PersonIDID des Auftraggebers („IsOrderID = 1“) bzw. der identifizerten Person („IsOrderID = 0“) vom Auftrag bzw. zum Warenkorb „VisitorOrOrderID“. Anmerkung : Bei „IsOrderID = 0“ kann hier „NULL“ stehen, weil der (zukünftige) Auftraggeber noch nicht bekannt ist.
integer6.0.2

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
-502Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)nur indirekt
-500Falsche Parameterdirekt und 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.5.4 2013-04-29Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
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_GetUsedVoucherCodes_Ad?VisitorOrOrderID=<value>&IsOrderID=<value>'

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetUsedVoucherCodes_Ad?VisitorOrOrderID=<value>&IsOrderID=<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_GetUsedVoucherCodes_Ad',
		array(
			'VisitorOrOrderID' => <value>,
			'IsOrderID' => <value>,
			// 'VoucherCode' => NULL,
			// 'FromValidationDateAndTime' => NULL,
			// 'ToValidationDateAndTime' => 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_GetUsedVoucherCodes_Ad">
			<Parameters>
				<Parameter Name="VisitorOrOrderID"><!-- integer value --></Parameter>
				<Parameter Name="IsOrderID"><!-- tinyint value --></Parameter>
				<!-- <Parameter Name="VoucherCode">NULL</Parameter> -->
				<!-- <Parameter Name="FromValidationDateAndTime">NULL</Parameter> -->
				<!-- <Parameter Name="ToValidationDateAndTime">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_getusedvouchercodes_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)