om_ModifySurchargeTypeTaxes_Ad [dstore]

Inhaltsverzeichnis

om_ModifySurchargeTypeTaxes_Ad

om_ModifySurchargeTypeTaxes_Ad

Prozedur, um Steuersätze zu den sogenannten „Surcharges“ (Aufschläge oder Rabatte) zu verwalten.

HTTP-Method	POST
HTTP-Auth	Optional
Tags	[om, Modify, Surcharge, Type, Taxes, 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
SurchargeTypeID		ID einer Aufschlags-/Rabattart (wie z.B. „Sonder-Rabatt“), zu der eine Steuersatz-Konfiguration vorgenommen werden soll. ACHTUNG : Gehört der „SurchargeType“ der Kategorie „Guthaben-Verrechnung“ (ID 5) an, kann der Steuersatz nicht geändert werden !	smallint	6.0.2
ValidFrom	NULL	Der Steuersatz „TaxRateID“ soll AB diesem Zeitpunkt (muß in der Zukunft liegen, bei „NULL“ wird automatisch der aktuelle Zeitpunkt gewählt) gelten	datetime	6.0.2
TaxRateID		ID eines Steuersatzes (mögliche Werte : s. mi_GetTaxRates). „NULL“ angegeben, um explizit KEINEN Steuersatz zu konfigurieren - dann wird nach den in der Hauptdienstleistung vorkommenden Steuersätzen (ihren Anteilen entsprechend) versteuert.	tinyint	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
-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.0.3	2011-09-07	Die „SurchargeTypeTaxes“ für „SurchargeTypes“ der Kategorie „Guthaben-Verrechnung“ können ab sofort nicht mehr geändert werden.
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_ModifySurchargeTypeTaxes_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifySurchargeTypeTaxes_Ad?SurchargeTypeID=<value>&TaxRateID=<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_ModifySurchargeTypeTaxes_Ad',
		array(
			'SurchargeTypeID' => <value>,
			'TaxRateID' => <value>,
			// 'ValidFrom' => 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_ModifySurchargeTypeTaxes_Ad">
			<Parameters>
				<Parameter Name="SurchargeTypeID"><!-- smallint value --></Parameter>
				<Parameter Name="TaxRateID"><!-- tinyint value --></Parameter>
				<!-- <Parameter Name="ValidFrom">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