Gibt die „benutzten“ - d.h. eingelösten oder zumindest erfolgreich validierten - Gutschein-Codes (aus der Tabelle „VoucherCodes“) aus.
HTTP-Method | GET |
HTTP-Auth | Optional |
Tags | |
Engine-Kategorie | order management |
Engine-Typ | Daten-Ermittlung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
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 ! | integer | 6.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. | tinyint | 6.0.2 | |
VoucherCode | NULL | 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 |
FromValidationDateAndTime | NULL | Falls angegeben werden nur Validierungen bzw. (bei Aufträgen sind es :) Einlösungen ermittelt, die NACH diesem Zeitpunkt stattfanden | datetime | 6.0.2 |
ToValidationDateAndTime | NULL | Falls angegeben werden nur Validierungen bzw. (bei Aufträgen sind es :) Einlösungen ermittelt, die VOR diesem Zeitpunkt stattfanden | datetime | 6.0.2 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
VisitorOrOrderID | ID eines Warenkorbs (wenn „IsOrderID = 0“) oder Auftrags (wenn „IsOrderID = 1“) | integer | 6.0.2 |
IsOrderID | Gibt an, ob es sich bei „VisitorOrOrderID“ um einen Warenkorb („0“ oder Auftrag („1“) handelt | tinyint | 6.0.2 |
VoucherCode | Ein Gutschein-Code, der im Auftrag „VisitorOrOrderID“ eingelöst (falls „IsOrderID = 1“) oder zum Warenkorb hinterlegt (wenn „IsOrderID = 0“) wurde | varchar(50) | 6.0.2 |
LastValidationDateAndTime | Der Zeitpunkt der letzten (erfolgreichen) Validierung des Codes | datetime | 6.0.2 |
PersonID | ID 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. | integer | 6.0.2 |
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 5) |
---|---|---|
-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 |
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
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.2 | 2011-06-08 | Erstmalig in dieser Version erstellt |
Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
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 -
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();
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>