om_GetVoucherTypes_Ad [dstore]

Inhaltsverzeichnis

om_GetVoucherTypes_Ad

om_GetVoucherTypes_Ad

Ermittelt alle definierten Gutschein-Aktionen, die sogenannten „VoucherTypes“. Darunter sind Aktionen zu verstehen, zu denen
Codes generiert und an Kunden weitergegeben werden können, damit diese dann bei Einlösung einen Bonus erhalten, wie z.B. einen Auftragsrabatt oder einen Bonus-Artikel etc.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[om, Get, Voucher, Types, 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	NULL	ID einer Gutschein-Aktion. Falls angegeben wird nur der entsprechende Datensatz ermittelt.	smallint	6.0.2
VCodeOriginTypeID	NULL	ID einer Herkunftsart von Gutschein-Codes (also z.B. „importiert“ oder „generiert“). Falls angegeben werden nur Aktionen ermittelt, bei denen die Codes dieser Herkunftsart entsprechen müssen.	tinyint	6.0.2
CodeStatus	NULL	Falls angegeben, werden nur Aktionen ermittelt, die den hier angegebenen Status besitzen : - „0“ : Codes-Erzeugung und -Einlösung möglich - „1“ : Nur Einlösung von Codes (aber keine Generierung) möglich - „2“ : KEINE Code-Erzeugung/-Einlösung möglich	tinyint	6.0.2
SortByCodeCreationDate	0	„1“ angeben, um die Rückgabemenge nach dem Zeitpunkt sortieren zu lassen, an dem zuletzt ein Code zur jeweiligen Aktion erzeugt wurde (es gibt dann außerdem eine zusäztliche Rückgabespalte für diesen Zeitpunkt)	bit	6.0.2
OutputIntoOneID	0	Sollen (für om_GetVoucherTypeSurcharges_Ad z.B.) die IDs der ermittelten Aktionen auch/nur in „tempdb.dbo.OneID“ gespeichert werden ? - „0“ : Nein (nur Ergebnismenge) - „1“ : Nur in „OneID“ einfügen - „2“ : Ergebnismenge liefern & in „OneID“ einfügen	tinyint	6.0.2

Rückgabe

wenn SortByCodeCreationDate = 0

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
VoucherTypeID	ID einer Gutschein-Aktion	smallint	6.0.2
VoucherTypeDescription	Die Bezeichnung der „VoucherTypeID“, also praktisch der Name der Aktion	varchar(100)	6.0.2
VCodeOriginTypeID	ID der Herkunftsart zum „VoucherType“. Mögliche Werte s. om_GetVCodeOriginTypes_Ad.	tinyint	6.0.2
VCodeOriginType	Die Bezeichnung der Herkunftsart „VCodeOriginTypeID“	varchar(50)	6.0.2
GenerationPattern	Das Pattern, nach welchem Codes zur Aktion erzeugt werden. Immer „NULL“, wenn die Herkunftsart „Importiert“ ist, ansonsten entweder eine feste Zeichenkette (d.h. es gibt genau EINEN Code) oder eine „Generierungs-Funktion“ (z.B. '#randomstr(10)#').	varchar(255)	6.0.2
BenefitTypeID	ID einer Art von Bonus, die der Kunde bei Einlösung erhält (z.B. „Bonus-Artikel“). Mögliche Werte s. om_GetBenefitTypes_Ad.	tinyint	6.0.2
BenefitTypeDescription	Bezeichnung der Bonus-Art „BenefitTypeID“.	varchar(100)	6.0.2
ValidForXDays	Anzahl Tage, die ein Code der Aktion ab dem Zeitpunkt seiner Generierung gültig sein soll. Immer „NULL“ wenn „DefaultValidUntil“ NICHT „NULL“ ist. Das sich hieraus ergebende „Gültig bis“-Datum kann bei der Generierung eines Codes überschrieben werden.	smallint	6.0.2
DefaultValidUntil	Zeitpunkt bis zu dem ein Code der Aktion gültig ist (egal wann er generiert wird). Kann „NULL“ sein. Ist gleichzeitig „ValidForXDays“ auch „NULL“, muß bei Generierung eines Codes die Gültigkeitsdauer angegeben werden (s. om_CreateVoucherCodes_Ad).	datetime	6.0.2
CodeStatus	Gibt an, ob Codes zur Aktion generiert/importiert werden können bzw. noch gültig sind. Mögliche Werte : - „0“ : Erstellung und Einlösung möglich - „1“ : Einlösung möglich, aber keine Erstellung - „2“ : KEINE Erstellung und Einlösung möglich	smallint	6.0.2
XTimesUsable	Gibt an, wie oft ein Code der Aktion generell eingelöst werden kann („NULL“ bedeutet „unendlich oft“). Diese Einstellung gilt unabhängig von „XTimesUsablePerPerson“ !	integer	6.0.2
XTimesUsablePerPerson	Gibt an, wie oft ein Code der Aktion von einer Person eingelöst werden kann („NULL“ bedeutet „unendlich oft“). Dieser Wert ist immer „⇐ XTimesUsable“, da ein Code nicht öfter von einer Person eingelöst werden kann als er insgesamt einlösbar ist.	integer	6.0.2

wenn SortByCodeCreationDate = 1

Spaltenname	Beschreibung	SQL-Datentyp⁵⁾	ab Version
VoucherTypeID	ID einer Gutschein-Aktion	smallint	6.0.2
VoucherTypeDescription	Die Bezeichnung der „VoucherTypeID“, also praktisch der Name der Aktion	varchar(100)	6.0.2
VCodeOriginTypeID	ID der Herkunftsart zum „VoucherType“. Mögliche Werte s. om_GetVCodeOriginTypes_Ad.	tinyint	6.0.2
VCodeOriginType	Die Bezeichnung der Herkunftsart „VCodeOriginTypeID“	varchar(50)	6.0.2
GenerationPattern	Das Pattern, nach welchem Codes zur Aktion erzeugt werden. Immer „NULL“, wenn die Herkunftsart „Importiert“ ist, ansonsten entweder eine feste Zeichenkette (d.h. es gibt genau EINEN Code) oder eine „Generierungs-Funktion“ (z.B. '#randomstr(10)#').	varchar(255)	6.0.2
BenefitTypeID	ID einer Art von Bonus, die der Kunde bei Einlösung erhält (z.B. „Bonus-Artikel“). Mögliche Werte s. om_GetBenefitTypes_Ad.	tinyint	6.0.2
BenefitTypeDescription	Bezeichnung der Bonus-Art „BenefitTypeID“.	varchar(100)	6.0.2
ValidForXDays	Anzahl Tage, die ein Code der Aktion ab dem Zeitpunkt seiner Generierung gültig sein soll. Immer „NULL“ wenn „DefaultValidUntil“ NICHT „NULL“ ist. Das sich hieraus ergebende „Gültig bis“-Datum kann bei der Generierung eines Codes überschrieben werden.	smallint	6.0.2
DefaultValidUntil	Zeitpunkt bis zu dem ein Code der Aktion gültig ist (egal wann er generiert wird). Kann „NULL“ sein. Ist gleichzeitig „ValidForXDays“ auch „NULL“, muß bei Generierung eines Codes die Gültigkeitsdauer angegeben werden (s. om_CreateVoucherCodes_Ad).	datetime	6.0.2
CodeStatus	Gibt an, ob Codes zur Aktion generiert/importiert werden können bzw. noch gültig sind. Mögliche Werte : - „0“ : Erstellung und Einlösung möglich - „1“ : Einlösung möglich, aber keine Erstellung - „2“ : KEINE Erstellung und Einlösung möglich	smallint	6.0.2
XTimesUsable	Gibt an, wie oft ein Code der Aktion generell eingelöst werden kann („NULL“ bedeutet „unendlich oft“). Diese Einstellung gilt unabhängig von „XTimesUsablePerPerson“ !	integer	6.0.2
XTimesUsablePerPerson	Gibt an, wie oft ein Code der Aktion von einer Person eingelöst werden kann („NULL“ bedeutet „unendlich oft“). Dieser Wert ist immer „⇐ XTimesUsable“, da ein Code nicht öfter von einer Person eingelöst werden kann als er insgesamt einlösbar ist.	integer	6.0.2
LastCodeCreatedAt	Der Zeitpunkt, an dem zuletzt ein Code der Aktion generiert wurde	datetime	6.0.2

Sortierung der Rückgabe

(parameterunabängige Sortierung)

LastCodeCreatedAt (aufsteigend)

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	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.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_GetVoucherTypes_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁷⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetVoucherTypes_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_GetVoucherTypes_Ad',
		array(
			// 'VoucherTypeID' => NULL,
			// 'VCodeOriginTypeID' => NULL,
			// 'CodeStatus' => NULL,
			// 'SortByCodeCreationDate' => 0,
			// 'OutputIntoOneID' => 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_GetVoucherTypes_Ad">
			<Parameters>
				<!-- <Parameter Name="VoucherTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="VCodeOriginTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="CodeStatus">NULL</Parameter> -->
				<!-- <Parameter Name="SortByCodeCreationDate">0</Parameter> -->
				<!-- <Parameter Name="OutputIntoOneID">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