om_PerformCashAccTransact_Ad [dstore]

Inhaltsverzeichnis

om_PerformCashAccTransact_Ad

om_PerformCashAccTransact_Ad

Führt eine Transaktion (Zu- oder Abbuchung) für ein (Zahlungsmittel)-Kundenkonto.

HTTP-Method	POST
HTTP-Auth	Optional
Alias	om_PerformCashAccountTransaction_Ad
Tags	[om, Perform, Cash, Account, Transaction, Ad]
Engine-Kategorie	configurations
Engine-Typ	Daten-Änderung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
PersonID		ID einer Person, die Inhaber eines Kontos vom Typ „CashAccountTypeID“ ist und für das eine Buchung durchgeführt werden soll	integer	6.0.2
CashAccountTypeID		ID eines Typs oder Art von Konto, zu dem „PersonID“ ein Konto besitzt. Mögliche Werte s. om_GetCashAccountTypes. Anmekrung : Eine Person kann nur ein Konto eines Typs besitzen.	tinyint	6.0.2
TransactionTypeID		Bestimmt die Art der Transaktion (und damit auch, ob der Buchungswert, „TransactionValue“, positiv oder negativ sein muß). Mögliche Werte : - „2“ : „Guthabenauszahlung“ - „3“ : „Manuelle Guthabenkorrektur“ - „7“ : „Manuelle Guthabenaufladung“	tinyint	6.0.2
TransactionValue		Wert der Buchung („0“ ist nicht erlaubt) in der durch „CurrencyID“ bestimmten Währung. Durch „TransactionTypeID“ ergibt sich, welches Vorzeichen erlaubt ist : - „2“ : negatives Vorzeichen - „3“ : negatives Vorzeichen - „7“ : positives Vorzeichen	money	6.0.2
TransactionComment		Hier muß (!) ein Buchungstext angegeben werden, der dem Kontoinhaber bei Einsicht in seine Kontodaten für diese Buchung angezeigt wird.	varchar(100)	6.0.2
CurrencyID	NULL	ID einer Währung („UnitID“ aus der Kategorie „Währung“, mögliche Werte s. mi_GetUnits), in der „TransactionValue“ zu verstehen ist. Bei „NULL“ wird automatisch von der Währung, in der das Konto geführt wird, ausgegangen.	tinyint	6.0.2
SuspendUntil	NULL	Ein Datum (optional), bis zu dem die Buchung nur „vorgemerkt“ ist, d.h. auf den Kontostand wirkt sich die Buchung erst zu diesem Zeitpunkt aus. Aus diesem Grunde kann so ein Datum nur für POSITIVE Beträge angegeben werden !	datetime	6.0.2
InternalComment	NULL	Optionaler Kommentar für Administratoren/Entwickler zur Buchung, der nicht in öffentlichen („public“-)Prozeduren zurückgegeben wird, insbesondere also der Kontoinhaber nicht zu sehen bekommt	varchar(100)	6.0.2

Rückgabe

Die Prozedur hat keine Rückgaben.

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁴⁾
-1323	Die Person besitzt kein Konto zum angegebenen Typ	nur indirekt
-1322	Transaktion kann nicht durchgeführt weden, da der Status des Kontos dies nicht erlaubt	nur indirekt
-1321	Transaktion kann nicht durchgeführt weden, da das Konto keine ausreichende Deckung aufweist	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
-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
-503	Fehlerhafte Daten in einer Tabelle - genauere Fehlermeldung auf der Standardausgabe	nur indirekt
-502	Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)	nur indirekt
-501	Der Parameter „TableID“ und/oder der Parameter „TableKeyID“ ist ungültig	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.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

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

cURL

Unformatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_PerformCashAccTransact_Ad?PersonID=<value>&CashAccountTypeID=<value>&TransactionTypeID=<value>&TransactionValue=<value>&TransactionComment=<value>'

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_PerformCashAccTransact_Ad?PersonID=<value>&CashAccountTypeID=<value>&TransactionTypeID=<value>&TransactionValue=<value>&TransactionComment=<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_PerformCashAccTransact_Ad',
		array(
			'PersonID' => <value>,
			'CashAccountTypeID' => <value>,
			'TransactionTypeID' => <value>,
			'TransactionValue' => <value>,
			'TransactionComment' => '<value>',
			// 'CurrencyID' => NULL,
			// 'SuspendUntil' => NULL,
			// 'InternalComment' => NULL
		)
);
 
$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_PerformCashAccTransact_Ad">
			<Parameters>
				<Parameter Name="PersonID"><!-- integer value --></Parameter>
				<Parameter Name="CashAccountTypeID"><!-- tinyint value --></Parameter>
				<Parameter Name="TransactionTypeID"><!-- tinyint value --></Parameter>
				<Parameter Name="TransactionValue"><!-- money value --></Parameter>
				<Parameter Name="TransactionComment"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="CurrencyID">NULL</Parameter> -->
				<!-- <Parameter Name="SuspendUntil">NULL</Parameter> -->
				<!-- <Parameter Name="InternalComment">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