om_GetVoucherTypeStatistics_Ad [dstore]

Inhaltsverzeichnis

om_GetVoucherTypeStatistics_Ad

om_GetVoucherTypeStatistics_Ad

Gibt einige Statistikdaten zu Gutschein-Aktionen zurück.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[om, Get, Voucher, Type, Statistics, 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 Statistiken ermittelt werden sollen (Pflichtangabe)	smallint	6.0.3

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
NumberOfCodes	Die Anzahl aller erzeugten Codes.	integer	6.0.3
NumberOfUsedCodes	Die Anzahl der Codes, die mindestens einmal eingelöst wurden.	integer	6.0.3
NumberOfUnusedCodes	Die Anzahl der Codes, die noch nie eingelöst wurden.	integer	6.0.3
NumberOfMaxUsedCodes	Die Anzahl der Codes, die bereits so oft eingelöst wurden, wie es erlaubt ist (gemäß „XTimesUsable“-Einstellung der Aktion)	integer	6.0.3
MaxValidUntil	Der Zeitpunkt, an dem der letzte Code ausläuft	datetime	6.0.3
LastCodeUsedAtDateAndTime	Der Zeitpunkt, am dem das letzte Mal ein Code eingelöst wurde	datetime	6.0.3

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	1. „_mi_FinishProcedure“-Aufruf am Schluß fehlte 2. Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
6.0.3	2011-09-07	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_GetVoucherTypeStatistics_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetVoucherTypeStatistics_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_GetVoucherTypeStatistics_Ad',
		array(
			'VoucherTypeID' => <value>
		)
);
 
$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_GetVoucherTypeStatistics_Ad">
			<Parameters>
				<Parameter Name="VoucherTypeID"><!-- smallint value --></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