om_ConvertCurrency [dstore]

Inhaltsverzeichnis

om_ConvertCurrency

om_ConvertCurrency

Konvertiert einen Wert von einer Währungs-Einheit in eine andere.

HTTP-Method	POST
HTTP-Auth	Optional
Tags	[om, Convert, Currency]
Engine-Kategorie	order management
Engine-Typ	Daten-Änderung
Letzte Aktualisierung	5.1.6 (2006-09-14)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
Value		Der Wert, der konvertiert werden soll	decimal(16,6)	3.5.0
FromUnitID		ID der Einheit, in der „Value“ angegeben ist	tinyint	3.5.0
ToUnitID		ID der Einheit, in die „Value“ umgerechnet werden soll	tinyint	3.5.0
Date	NULL	Die Umrechnung von Einheiten ist immer an einen Zeitraum gebunden, und dieser Parameter gibt den Zeitpunkt an (falls „NULL“, wird das aktuelle Datum gewählt), zu dem umgerechnet weden soll	datetime	3.5.0
SelectResult	0	„1“ angeben, um ZUSÄTZLICH zum Ausgabeparameter das Ergebnis als Rückgabemenge zu erhalten	bit	3.5.4

Rückgabe

wenn SelectResult = 1

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
ConvertedValue	Der umgerechnete Wert von „Value“ in der Einheit „ToUnitID“	decimal(16,6)	3.5.4

Output-Parameter

ConvertedValue

Ausgabeparameter, der nach dem Aufruf den umgerechneten Wert von „Value“ in der Einheit „ToUnitID“ enthält

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-530	Der Wert ist nicht konvertierbar	nur indirekt
-503	Fehlerhafte Daten in einer Tabelle - genauere Fehlermeldung auf der Standardausgabe	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

5.1.6	2006-09-14	1. „FromUnitID“ und „ToUnitID“ hatten den falschen Datentyp - nicht „smallint“ sondern „tinyint“ muß es sein ! 2. Überarbeitung des Quelltextes und der Doku
4.0.0	2003-04-03	Die (einzige) Rückgabespalte war nicht benannt
3.5.4	2001-03-11
3.5.0	2000-11-23	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_ConvertCurrency im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ConvertCurrency?Value=<value>&FromUnitID=<value>&ToUnitID=<value>'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ConvertCurrency?Value=<value>&FromUnitID=<value>&ToUnitID=<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_ConvertCurrency',
		array(
			'Value' => <value>,
			'FromUnitID' => <value>,
			'ToUnitID' => <value>,
			// 'Date' => NULL,
			// 'SelectResult' => 0
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();
 
$OutputParams = $xml_result->getOutputParametersAsArray();

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_ConvertCurrency">
			<Parameters>
				<Parameter Name="Value"><!-- decimal value --></Parameter>
				<Parameter Name="FromUnitID"><!-- tinyint value --></Parameter>
				<Parameter Name="ToUnitID"><!-- tinyint value --></Parameter>
				<!-- <Parameter Name="Date">NULL</Parameter> -->
				<!-- <Parameter Name="SelectResult">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