om_GetVoucherCodes_Ad [dstore]

Inhaltsverzeichnis

om_GetVoucherCodes_Ad

om_GetVoucherCodes_Ad

Liefert existierende Gutschein-Codes.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[om, Get, Voucher, Codes, 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
FromCreationDate		Wird nur beachtet, wenn „NULL“ für „VoucherCode“ angegeben ist und MUSS dann auch angegeben sein ! Es werden alle Codes ermittelt, die NACH (einschließlich) diesem Zeitpunkt angelegt (importiert oder generiert z.B.) wurden.	datetime	6.0.2
ToCreationDate	NULL	Wird nur beachtet, wenn „NULL“ für „VoucherCode“ angegeben ist ! Falls angegeben, werden nur Codes ermittelt, die VOR (einschließlich) diesem Zeitpunkt angelegt (importiert oder generiert z.B.) wurden.	datetime	6.0.2
VoucherCode	NULL	Ein konkreter Gutschein-Code. Falls angegeben, wird nur der entsprechende Datensatz zurückgegeben.	varchar(50)	6.0.2
VoucherTypeID	NULL	Wird nur beachtet, wenn „NULL“ für „VoucherCode“ angegeben ist ! ID einer Gutschein-Aktion (mögliche Werte s. om_GetVouchertTypes_Ad). Falls angegeben, werden nur Codes dieser Aktion ermittelt.	smallint	6.0.2
GetUsedCodes	0	Zur Filterung hinsicht. „Einlösbarkeit“ : * „0“ : Keine Einschr. * „1“ : Nur Codes, die MINDESTENS EINMAL eingelöst wurden * „2“ : Nur Codes, die noch NIE eingelöst wurden * „3“ : Nur Codes, die wg. der max. Einlösbarkeit NICHT mehr EINLÖSBAR sind	tinyint	6.0.3

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
VoucherCode	Ein Gutschein-Code	varchar(50)	6.0.2
VoucherTypeID	Die ID der Gutschein-Aktion, zu der „VoucherCode“ gehört	smallint	6.0.2
VoucherTypeDescription	Bezeichnung der Gutschein-Aktion „VoucherTypeID“	varchar(100)	6.0.2
CreatedAtDateAndTime	Der Zeitpunkt, an dem „VoucherCode“ erzeugt wurde	datetime	6.0.2
CreatedByUserID	Die ID eines Benutzers (der in „UserInfo“ registriert ist) der „VoucherCode“ erzeugt hat	smallint	6.0.2
CodeValidUntil	Der Zeitpunkt bis zu dem „VoucherCode“ gültig ist (danach kann er nicht mehr eingelöst werden)	datetime	6.0.2
UsageCount	Anzahl der bisher erfolgten Einlösungen	integer	6.0.3
LastUsageAtDateAndTime	Datum an dem der Code das letzte mal eingelöst wurde	datetime	6.0.3

Sortierung der Rückgabe

(parameterunabängige Sortierung)

VoucherTypeID (aufsteigend)
CreatedAtDateAndTime (absteigend)

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
-502	Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)	nur indirekt
-500	Falsche Parameter	direkt 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-29	Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
6.5.4	2013-04-29	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
6.0.3	2011-09-07	1. Neuer Parameter „GetUsedCodes“ 2. Neue Rückgabespalten „UsageCount“ und „LastUsageAtDateAndTime“
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_GetVoucherCodes_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetVoucherCodes_Ad?FromCreationDate=<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_GetVoucherCodes_Ad',
		array(
			'FromCreationDate' => <value>,
			// 'ToCreationDate' => NULL,
			// 'VoucherCode' => NULL,
			// 'VoucherTypeID' => NULL,
			// 'GetUsedCodes' => 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_GetVoucherCodes_Ad">
			<Parameters>
				<Parameter Name="FromCreationDate"><!-- datetime value --></Parameter>
				<!-- <Parameter Name="ToCreationDate">NULL</Parameter> -->
				<!-- <Parameter Name="VoucherCode">NULL</Parameter> -->
				<!-- <Parameter Name="VoucherTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="GetUsedCodes">0</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