om_GetCashAccTransactions_Pu [dstore]

Inhaltsverzeichnis

om_GetCashAccTransactions_Pu

om_GetCashAccTransactions_Pu

Liefert die einem (Zahlungsmittel-) Kundenkonto zugeordneten Transaktionen (Zu- und Abbuchungen) zurück, sofern der Konto-Inhalber identifiziert werden kann.

HTTP-Method	GET
HTTP-Auth	Optional
Alias	om_GetCashAccountTransactions_Pu
Tags	[om, Get, Cash, Account, Transactions, Pu]
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
PersonIdentificationValues		Liste von Werten, die den Kontoinhaber identifizieren. Diese Werte müssen Eigenschaften zu den Merkmal-IDs sein, die in „PersonTypeSettings“ zur „PersonTypeID“ zum Schlüssel „PersonIdentificationIDs“ hinterlegt sind.	varchar(255)	6.0.2
PersonTypeID		ID des Personen-Typs dem die zu identifizierende Person angehört. Dieser muß bei einer Identifizierung immer mit angegeben werden, da die Merkmale zur Identifizierung pro Personentyp variieren können.	tinyint	6.0.2
UniqueID		Eindeutige ID eines Besuchers, die der zu identifizierenden Person zuzuordnen ist. Wenn die Identifizierungsdaten bereits in „SessionManagement“ (zur „UniqueID“) gespeichert sind, darf „PersonIdentificationValues“ „NULL“ sein bzw. den Wert '' enthalten.	varchar(50)	6.0.2
CashAccountTypeID		ID eines Typs oder Art von Konto, zu dem die identifizierte Person ein Konto besitzt. Mögliche Werte s. om_GetCashAccountTypes. Anmerkung : Eine Person kann nur ein Konto eines Typs besitzen.	tinyint	6.0.2
SeparatorInIdentVals	'¶'	Gibt an, durch welches Zeichen die Werte in „PersonIdentificationValues“ getrennt sind	varchar(4)	6.0.2
OnlyTransactionsSince	NULL	Falls angegeben, werden nur Transaktionen AB (einschließlich) diesem Zeitpunkt ermittelt. Anmerkung : Selbstverständlich hat die Angabe dieses Parameters auf den über „AccountBalance“ gelieferten Kontostand KEINEN Einfluß.	datetime	6.0.2

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
TransactionID	ID einer Transaktion	integer	6.0.2
PersonID	ID der identifizierten Person (der das Konto gehört)	integer	6.0.2
CashAccountTypeID	ID des Kontotyps (also z.Zt. immer „CashAccountTypeID“)	tinyint	6.0.2
TransactionDateAndTime	Zeitpunkt der Transaktion	datetime	6.0.2
TransactionTypeID	ID des Transaktionstyps zu der Transaktion	tinyint	6.0.2
TransactionType	Bezeichnung des Transaktionstyps „TransactionTypeID“	varchar(100)	6.0.2
TransactionValue	Wert der Transaktion (positiver Wert : „Zubuchung“, sonst „Abbuchung)	money	6.0.2
TransactionComment	Kommentar zur Transaktion	varchar(100)	6.0.2
SuspendedUntil	Kann „NULL“ sein. Steht hier ein Datum, bedeutet dies, dass die Transaktion bis zu diesem Zeitpunkt als „vorgemerkt“ aber noch nicht „gebucht“ gilt. Liegt das Datum in der Zukunft, ist die Transaktion noch NICHT im aktuellen Kontostand berücksichtigt.	datetime	6.0.2

Sortierung der Rückgabe

(parameterunabängige Sortierung)

TransactionDateAndTime (aufsteigend)

Output-Parameter

AccountBalance

Ausgabeparameter für den aktuellen Stand des Kontos vom Typ „CashAccountTypeID“ des identifizierten Inhabers

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-1323	Die Person besitzt kein Konto zum angegebenen Typ	nur indirekt
-660	Identifikation fehlgeschlagen	nur indirekt
-621	Fehlender oder falscher Eintrag in PersonTypeSettings	nur indirekt
-602	Zur defaultUniqueID („VisitorID = -2“) können keinerlei Daten gespeichert oder verändert werden	nur indirekt
-599	Lizenz ist ungültig oder abgelaufen	nur indirekt
-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
-550	Fehlender oder falscher Eintrag in Settings	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	„Start-/Finish-Procedure“-Logik eingebaut, s. Ticket #3670
7.0.0	2013-06-04	Datentyp des Parameter „SeparatorInIdentVals“ [wg. UTF-8 Unterstützung] verlängert [von „1“ auf „4“]
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_GetCashAccTransactions_Pu im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetCashAccTransactions_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<value>&CashAccountTypeID=<value>'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetCashAccTransactions_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<value>&CashAccountTypeID=<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_GetCashAccTransactions_Pu',
		array(
			'PersonIdentificationValues' => '<value>',
			'PersonTypeID' => <value>,
			'UniqueID' => '<value>',
			'CashAccountTypeID' => <value>,
			// 'SeparatorInIdentVals' => '¶',
			// 'OnlyTransactionsSince' => NULL
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();
 
$OutputParams = $xml_result->getOutputParametersAsArray();

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_GetCashAccTransactions_Pu">
			<Parameters>
				<Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter>
				<Parameter Name="PersonTypeID"><!-- tinyint value --></Parameter>
				<Parameter Name="UniqueID"><!-- varchar value --></Parameter>
				<Parameter Name="CashAccountTypeID"><!-- tinyint value --></Parameter>
				<!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> -->
				<!-- <Parameter Name="OnlyTransactionsSince">NULL</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