engine:procedures:om

Inhaltsverzeichnis

om_GetTaxTypes

om_GetTaxTypes

ACHTUNG : Diese Prozedur NICHT MEHR VERWENDEN. Die Funktionalität der „TaxTypes“ ist komplett entfallen. Diese dienten bis einschl. Version 6.0.1 im Zusammenspiel mit „Taxes“ (gleichnamige Tabelle) dazu, für Versandkosten und Zahlungskosten feste Steuersätze hinterlegen zu können. Stattdessen werden seit Version 6.0.2 Steuersätze zu einzelnen „Surcharges“ hinterlegt, s. om_GetSurchargeTypeTaxes. Das Pendant zu den „TaxTypes“ sind die Kategorien von „Surcharges“, die „SurchargeTypeCategories“ (s. om_GetSurchargeTypeCategories).

Aus Abwärtskompatibilitäts-Gründen wird hier eine fest codierte Rückgabemenge geliefert (die das darstellt, was bis 6.0.1
geliefert wurde, da die „TaxTypes“ sowieso nicht konfigurierbar waren).

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[om, Get, Tax, Types]
Engine-Kategorie	order management
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	6.0.2 (2011-06-08)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
TaxTypeID	NULL	Wenn nicht „NULL“ angegeben ist, werden diese Werte noch (wg. Abwärtskompatibilität) unterstützt : - „1“ : Steuersatz-Art für „Zahlungskosten“ - „2“ : Steuersatz-Art für „Versandkosten“	tinyint	3.5.20

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
TaxTypeID	ID einer Steuerart - es sind nur fest codierte Werte (wg. Abwärtskompatibilität) möglich : - „1“ : Steuersatz-Art für „Zahlungskosten“ - „2“ : Steuersatz-Art für „Versandkosten“	tinyint	3.5.20
TaxType	Bezeichnung der „TaxTypeID“	varchar(100)	3.5.20

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Die Prozedur hat keine Fehlercodes.

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

6.0.2	2011-06-08	Tabelle „TaxTypes“ ist weggefallen ⇒ Änderung der Implementierung und Anpassung der Doku
3.5.20	2002-07-22	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_GetTaxTypes im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetTaxTypes'

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetTaxTypes' | 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_GetTaxTypes',
		array(
			// 'TaxTypeID' => 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_GetTaxTypes">
			<Parameters>
				<!-- <Parameter Name="TaxTypeID">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org