Gibt erstellte „PrepaidCodes“ zurück (durch deren Einlösung das Guthaben-Konto einer Person „aufgeladen“ werden kann).
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 |
---|---|---|---|---|
PrepaidCode | NULL | Falls angegeben, wird nur dieser eine „PrepaidCode“ in die Ergebnismenge aufgenommen. Alle anderen Parameter werden ignoriert ! | varchar(50) | 6.0.2 |
FromCodeValidUntil | NULL | Wird nur beachtet, wenn „PrepaidCode“ „NULL“ ist ! Falls angegeben werden nur „PrepaidCodes“ in der Ergebnismenge zurückgegeben, deren Wert für „CodeValidUntil“ größer oder gleich dem angegebenen Zeitpunkt ist. | datetime | 6.0.2 |
ToCodeValidUntil | NULL | Wird nur beachtet, wenn „PrepaidCode“ „NULL“ ist ! Falls angegeben werden nur „PrepaidCodes“ in der Ergebnismenge zurückgegeben, deren Wert für „CodeValidUntil“ kleiner oder gleich dem angegebenen Zeitpunkt ist. | datetime | 6.0.2 |
FilterByUseState | 2 | Wird nur beachtet, wenn „PrepaidCode“ „NULL“ ist ! Filterung, welche Codes ermittelt werden sollen : - „0“ : benutzte und unbenutzte - „1“ : nur bereits benutzte - „2“ : nur unbenutzte Codes (andere Werte und auch „NULL“ sind nicht erlaubt !) | tinyint | 6.0.2 |
OrderBy | NULL | Wie soll die Rückgabemenge sortiert werden (⇒ siehe Rückgabemengen-Sortierung) ? | varchar(20) | 6.0.2 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
PrepaidCode | Ein Prepaid-Code | varchar(50) | 6.0.2 |
PrepaidValue | Der „Geldwert“ des Codes in der durch „CurrencyID“ angegebenen Währung | money | 6.0.2 |
CurrencyID | Die ID der Währung („UnitID“ aus der Kategorie „Währung“, mögliche Werte s. mi_GetUnits), in der „PrepaidValue“ angegeben ist | tinyint | 6.0.2 |
CodeValidUntil | Der Zeitpunkt bis zu dem der Code gültig ist, also eingelöst werden kann | datetime | 6.0.2 |
CodeAlreadyUsed | Gibt an, ob „PrepaidCode“ schon eingelöst wurde („1“) oder nicht („0“) | bit | 6.0.2 |
UsedForTransactionID | Die ID einer Transaction, die für die Einlösung des Codes verwendet wurde (s. om_GetCashAccTransactions_Ad). Nicht eingelöste Codes („CodeAlreadyUsed = 0“) haben hier natürlich den Wert „NULL“. | integer | 6.0.2 |
GeneratedByOrderID | ID des Auftrags, durch den der Code erzeugt wurde Anmerkung : Hier kann und wird für sehr alte Codes „NULL“ stehen, da die Aufträge (Tabelle „Orders“) nur begrenzt im dStore gespeichert werden (s. „Settings“-Eintrag „MaxMonthsInBillsAndOrders“) ! | integer | 6.0.2 |
GeneratedAtDateAndTime | Wann der Code generiert wurde. S. Anmerkung zu „GeneratedByOrderID“. | datetime | 6.0.2 |
wenn OrderBy is NULL
wenn OrderBy = 'Value'
wenn OrderBy = 'ValidUntil'
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_GetPrepaidCodes_Ad'
Mit xmllint 6) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/om_GetPrepaidCodes_Ad' | 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_GetPrepaidCodes_Ad', array( // 'PrepaidCode' => NULL, // 'FromCodeValidUntil' => NULL, // 'ToCodeValidUntil' => NULL, // 'FilterByUseState' => 2, // 'OrderBy' => 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_GetPrepaidCodes_Ad"> <Parameters> <!-- <Parameter Name="PrepaidCode">NULL</Parameter> --> <!-- <Parameter Name="FromCodeValidUntil">NULL</Parameter> --> <!-- <Parameter Name="ToCodeValidUntil">NULL</Parameter> --> <!-- <Parameter Name="FilterByUseState">2</Parameter> --> <!-- <Parameter Name="OrderBy">NULL</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>