mi_ModifyTaxRates_Ad [dstore]

Inhaltsverzeichnis

mi_ModifyTaxRates_Ad

mi_ModifyTaxRates_Ad

Erstellt, bearbeitet oder löscht im System definierte Steuersätze, die sogenannten „TaxRates“.

Anmerkungen :

1.) Der Steuersatz (also die Prozent-Angabe) selbst kann NICHT nachträglich geändert werden, lediglich die folgenden Einstellungen (den gleichnamigen Parametern entsprechend) :

„TaxRateDescription“
„UseAsFallback“
„Active“

2.) Gelöscht werden kann ein Steuersatz nur, wenn er nicht mehr (z.B. in „SurchargeTypeTaxes“) verwendet wird.

3.) Nur ein einziger Steuersatz darf als „Fallback“-Option markiert sein. Wird also ein neuer Datensatz angelegt oder ein existierender Datensatz so geändert, daß „UseAsFallback“ auf „1“ gesetzt wird (durch den gleichnamigen Parameter), setzen wir automatisch den Wert bei allen ANDEREN Steuersätzen auf „0“.

HTTP-Method	POST
HTTP-Auth	Optional
Tags	[mi, Modify, Tax, Rates, 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
TaxRateID		ID eines Steuersatzes. Falls angegeben, wird der entsprechende Datensatz je nach „DeleteTaxRate“ geändert oder gelöscht, bei Angabe von „NULL“ wird ein neuer Steuersatz definiert.	tinyint	6.0.2
TaxRate		Der Steuersatz als Angabe in Prozent	decimal(4,2)	6.0.2
TaxRateDescription		Die Beschreibung des Steuersatzes (z.B. „Normalsteuersatz“)	varchar(100)	6.0.2
UseAsFallback	0	Gibt an, ob der Steuersatz in speziellen Fällen, wo kein Steuersatz konfiguriert ist und auch nicht „künstlich bestimmt“ werden kann, verwendet werden soll	bit	6.0.2
Active	1	Gibt an, ob der Steuersatz aktiv ist. Dies ist nur eine Information für „Client-Anwendungen“. Engineseitig gibt es zu dieser Information keine implementierte Funktionalität.	bit	6.0.2
DeleteTaxRate	0	Wird nur beachtet, wenn „TaxRateID“ angegeben ist. Entscheidet darüber, ob der angegebene Steuersatz 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 ⁴⁾
-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

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	1. Falscher „transaction isolation level“ zu Beginn 2. Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
7.0.0	2013-06-04	Kleiner Doku-Fehler [verwendete Prozeduren]
6.5.3	2013-03-18	Interne Anpassungen wg. UTF8-Unterstützung
6.0.4	2011-10-21	Holger Wies : Bugfix wg. „INSERT INTO DUPLICATE KEY“ beim Hinzufügen einer neuen „TaxRate“
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:

mi_ModifyTaxRates_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/mi_ModifyTaxRates_Ad?TaxRateID=<value>&TaxRate=<value>&TaxRateDescription=<value>'

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/mi_ModifyTaxRates_Ad?TaxRateID=<value>&TaxRate=<value>&TaxRateDescription=<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'),
	'mi_ModifyTaxRates_Ad',
		array(
			'TaxRateID' => <value>,
			'TaxRate' => <value>,
			'TaxRateDescription' => '<value>',
			// 'UseAsFallback' => 0,
			// 'Active' => 1,
			// 'DeleteTaxRate' => 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="mi_ModifyTaxRates_Ad">
			<Parameters>
				<Parameter Name="TaxRateID"><!-- tinyint value --></Parameter>
				<Parameter Name="TaxRate"><!-- decimal value --></Parameter>
				<Parameter Name="TaxRateDescription"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="UseAsFallback">0</Parameter> -->
				<!-- <Parameter Name="Active">1</Parameter> -->
				<!-- <Parameter Name="DeleteTaxRate">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