Benutzer-Werkzeuge

Webseiten-Werkzeuge

Action disabled: source

engine:procedures:om_getpaymenttypes_ad

om_GetPaymentTypes_Ad

Gibt die im „dStore“ definierten Zahlungsarten zurück.

HTTP-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategorieorder management
Engine-TypDaten-Ermittlung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
LanguageID0 ID einer Sprache, in der die Bezeichnung der Zahlungsart übersetzt werden soll (→ Rückgabespalte „TranslatedDescription“)
tinyint3.5.0
PaymentTypeIDNULL ID einer Zahlungsart. Angeben, um nur den zugehörigen Datensatz zu erhalten.
smallint3.5.16
OnlyActive0 „1“ angeben, um nur die aktiven (momentan gültigen) Zahlungsarten zu erhalten
bit3.5.20
ValidAtDateAndTimeNULL Über die Änderungen einer Zahlungsart wird eine Historie gepflegt, daher kann man sich mit diesem Parameter die zu einem bestimmten Zeitpunkt definierten Zahlungsarten ermitteln lassen (bei „NULL“ wird die aktuelle Konfiguration herangezogen)
datetime5.0.2

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
PaymentTypeIDID einer Zahlungsart
smallint3.5.0
PaymentTypeDescriptionBezeichnung der Zahlungsart „PaymentTypeID“
varchar(100)3.5.0
TranslatedDescriptionÜbersetzung von „PaymentTypeDescription“ in der durch „LanguageID“ angegebenen Sprache. Immer „NULL“, wenn „LanguageID“ „0“ oder „NULL“ ist, oder ein Wert für „ValidAtDateAndTime“ gesetzt ist (da es für die Übersetzungen KEINE Historie gibt) !
varchar(100)3.5.0
RegionIDID einer Region, die bestimmte Länder („Countries“) zusammenfaßt. om_GetPaymentAndShipping_Pu bietet die Zahlungsart „PaymentTypeID“ nur dann an, wenn der Auftraggeber aus einem Land kommt, das dieser Region angehört.
smallint3.5.0
RegionBezeichnung der Region „RegionID“
varchar(100)3.5.0
GrossSumFromom_GetPaymentAndShipping_Pu bietet die Zahlungsart „PaymentTypeID“ nur dann an, wenn der Brutto-Bestellwert (in der Einheit „CurrencyID“) mindestens so hoch wie dieser Betrag ist
money5.0.2
GrossSumToom_GetPaymentAndShipping_Pu bietet die Zahlungsart „PaymentTypeID“ nur dann an, wenn der Brutto-Bestellwert (in der Einheit „CurrencyID“) höchstens so hoch wie dieser Betrag ist
money5.0.2
CurrencyIDID einer Währung, in der „GrossSumFrom“ und „GrossSumTo“ angegeben sind
tinyint3.5.0
CurrencySymbolSymbol (im Regelfall der ISO-Code) der Einheit „CurrencyID“
varchar(10)3.5.0
Active„0“ : Die Zahlungsart ist nicht mehr aktiv, d.h. kann für neue Aufträge nicht mehr verwendet werden (wird aber noch in alten Aufträgen referenziert und kann daher nicht gelöscht werden)
„1“ : „PaymentTypeID“ ist aktiv, also aktuell auswählbar
bit3.5.20
CreatedAtDateAndTimeWann wurde die Zahlungsart angelegt. Anmerkung : Kann „NULL“ sein, da diese Spalte erst seit Version 5.0.2 der Tabelle „PaymentTypes“ hinzugefügt wurde !
datetime5.0.2
SurchargeTypeIDID einer Preis-Aufschlags/Rabatt-Art, die bei der Zahlungsart „PaymentTypeID“ anfällt, wie z.B. „Nachnahmegebühr“ o.ä.
smallint3.5.0
PriorityNoBestimmt die Reihenfolge bei der Berechnung aller „PaymentTypeID“ zugeordneten „Surcharges“
tinyint6.0.2
SurchargeTypeDescriptionBezeichnung der „SurchargeTypeID“
varchar(100)3.5.0
SurchargeValueAufschlag/Rabatt, der bei Wahl der „PaymentTypeID“ in einem Auftrag berechnet/gewährt wird
decimal(16,6)6.0.2
SurchargeIsAbsoluteValueGibt an, wie „SurchargeValue“ zu verstehen ist :
„0“ : Es ist eine relative (d.h. prozentuale) Angabe
„1“ : Es ist eine absolute Währungs-Angabe in der Einheit SurchargeUnitID, und zwar ein als NETTO-Wert
„2“ : Wie „1“ nur als BRUTTO-Wert zu verstehen
tinyint6.0.2
SurchargeUnitIDID der Einheit, in der „SurchargeValue“ angegeben ist
tinyint6.0.2
SurchargeUnitSymbolSymbol/Abkürzung der Einheit „SurchargeUnitID“
varchar(10)6.0.2
BruttoSumFromNicht verwenden, stattdessen : „GrossSumFrom“
money3.5.0
BruttoSumToNicht verwenden, stattdessen : „GrossSumTo“
money3.5.0
CostNicht verwenden, stattdessen : „SurchargeValue“
decimal(16,6)3.5.0
CostCurrencyIDNicht verwenden, stattdessen : „SurchargeUnitID“
tinyint4.0.0
CostCurrencySymbolNicht verwenden, stattdessen : „SurchargeUnitSymbol“
varchar(10)4.0.0
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • PaymentTypeID (aufsteigend)
  • PriorityNo (aufsteigend)
  • SurchargeTypeID (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 5)
-569Der Benutzer hat kein Ausführungsrecht für die Prozedurnur indirekt
-567Die Prozedur darf z. Zt. nicht ausgeführt werdennur indirekt
-566Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werdennur indirekt
-535Das Datum liegt nicht in der Vergangenheitnur indirekt
-530Der Wert ist nicht konvertierbarnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-504Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochennur indirekt
-500Falsche Parameternur 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-29Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
7.0.4 2014-03-19„set forceplan off“-Anweisung fehlte an einer Stelle
6.0.2 2011-06-081. Konzept-Änderungen bzgl. „Surcharges“-Logik
2. Neue Rückgabespalten „PriorityNo“, „SurchargeValue“, „SurchargeIsAbsoluteValue“, „SurchargeUnitID“ und „SurchargeUnitSymbol“
3. Neue Sortierung der Rückgabemenge
5.1.5 2006-08-29Explizites „ORDER BY“ eingefügt, um die Sortierung der Rückgabemenge zu garantieren
5.0.2 2005-04-291. Berücksichtigung von „PaymentTypesHistory“ ⇒ Neuer Parameter „ValidAtDateAndTime“
2. Interne Optimierungen
3. Neue Rückgabespalten „CreatedAtDateAndTime“, „GrossSumFrom“ und „GrossSumTo“
4.0.14 2004-06-031. Aufruf der Prozeduren „_mi_StartProcedure“ und „_mi_FinishProcedure“
2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
4.0.0 2003-04-031. Fehlende Doku der seit dem 06.06.2002 eingeführten neuen Rückgabespalte
2. Neue Rückgabespalten „CostCurrencyID“ und „CostCurrencySymbol“
3.5.20 2002-07-22
3.5.16 2002-04-25
3.5.0 2000-11-23Erstmalig 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:

cURL

Unformatierte Ausgabe:

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

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetPaymentTypes_Ad' | 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_GetPaymentTypes_Ad',
		array(
			// 'LanguageID' => 0,
			// 'PaymentTypeID' => NULL,
			// 'OnlyActive' => 0,
			// 'ValidAtDateAndTime' => 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_GetPaymentTypes_Ad">
			<Parameters>
				<!-- <Parameter Name="LanguageID">0</Parameter> -->
				<!-- <Parameter Name="PaymentTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="OnlyActive">0</Parameter> -->
				<!-- <Parameter Name="ValidAtDateAndTime">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
6)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/om_getpaymenttypes_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)