om_ModifyCustomerCashAcc_Ad [dstore]

Inhaltsverzeichnis

om_ModifyCustomerCashAcc_Ad

om_ModifyCustomerCashAcc_Ad

Prozedur zum Erstellen, Ändern und Löschen von (Zahlungsmittel-)Konten („CustomerCashAccount“).

HTTP-Method	POST
HTTP-Auth	Optional
Alias	om_ModifyCustomerCashAccounts_Ad
Tags	[om, Modify, Customer, Cash, Accounts, Ad]
Engine-Kategorie	order management
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 bzw. werden soll (falls die Kombination „PersonID“-„CashAccountTypeID“ nicht existiert, wird ein neues Konto angelegt)	integer	6.0.2
CashAccountTypeID		ID eines Typs oder Art von Konto, zu dem „PersonID“ ein Konto besitzt oder besitzen soll. Mögliche Werte s. om_GetCashAccountTypes. Anmekrung : Eine Person kann nur ein Konto eines Typs besitzen.	tinyint	6.0.2
CurrencyID	NULL	ID einer Währung („UnitID“ aus der Kategorie „Währung“, mögliche Werte s. mi_GetUnits), in der das Konto geführt werden soll. Falls „NULL“, wählt die Prozedur die „DefaultCurrencyID“ aus „Settings“. Nicht änderbar, wenn schon Transaktionen existieren !	tinyint	6.0.2
AccountStatus	0	Status des Kontos (bei Angabe von „NULL“ wird automatisch „0“ gewählt). Mögliche Werte : - „0“ : Aktiv (alle Transaktionen erlaubt) - „1“ : Gesperrt, nur ZUbuchungen sind erlaubt - „2“ : Inaktiv (KEINE Transaktionen erlaubt)	tinyint	6.0.2
MinAccountBalance	NULL	Welcher minimale Saldo erreicht werden darf, d.h. führt eine Transaktion zu einem niedrigeren Kontostand, wird sie abgebrochen. Bei „NULL“ wird der zu „CashAccountTypeID“ konfigurierte Wert gewählt. Nur änderbar, wenn der aktuelle Kontostand paßt !	money	6.0.2
DeleteAccount	0	Existiert bereits ein Konto (d.h. die Kombination „PersonID“-„CashAccountTypeID“), entscheidet dieser Parameter, ob das Konto geändert („0“) oder gelöscht („1“) werden soll.	bit	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 ⁴⁾
-1325	Konto-Einstellung kann aufgrund des aktuellen Kontostandes nicht mehr geändert werden	nur direkt
-1324	Konto kann nicht mehr geändert/gelöscht werden, da bereits Transaktionen vorliegen	nur direkt
-1323	Die Person besitzt kein Konto zum angegebenen Typ	nur indirekt
-621	Fehlender oder falscher Eintrag in PersonTypeSettings	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
-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]
7.0.4	2014-03-19	Kleine Kosmetik-Korrektur : Bei einigen Code-Zeilen war am Ende ein CR-Zeichen, was wir entfernt haben
6.0.4	2011-10-21	Holger Wies : Bugfix bezgl. fehlender Konvertierung der „DefaultCurrencyID“ von varchar [aus Settingseintrag] nach tinyint.
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_ModifyCustomerCashAcc_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifyCustomerCashAcc_Ad?PersonID=<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_ModifyCustomerCashAcc_Ad',
		array(
			'PersonID' => <value>,
			'CashAccountTypeID' => <value>,
			// 'CurrencyID' => NULL,
			// 'AccountStatus' => 0,
			// 'MinAccountBalance' => NULL,
			// 'DeleteAccount' => 0
		)
);
 
$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_ModifyCustomerCashAcc_Ad">
			<Parameters>
				<Parameter Name="PersonID"><!-- integer value --></Parameter>
				<Parameter Name="CashAccountTypeID"><!-- tinyint value --></Parameter>
				<!-- <Parameter Name="CurrencyID">NULL</Parameter> -->
				<!-- <Parameter Name="AccountStatus">0</Parameter> -->
				<!-- <Parameter Name="MinAccountBalance">NULL</Parameter> -->
				<!-- <Parameter Name="DeleteAccount">0</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