om_GetPaymentForShipping_Ad [dstore]

Inhaltsverzeichnis

om_GetPaymentForShipping_Ad

om_GetPaymentForShipping_Ad

Gibt mögliche Kombinationen von Zahlungs- und Versandarten zurück.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[om, Get, Payment, For, Shipping, Ad]
Engine-Kategorie	order management
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
LanguageID		ID einer Sprache, in der die Bezeichnungen und Beschreibungen für Zahlungs- bzw. Versandart übersetzt werden sollen (→ Rückgabespalten „TranslatedDescription“ und „TranslatedDetailedDescription“)	tinyint	3.5.0
PaymentTypeID	NULL	ID einer Zahlungsart. Optionaler Filter, um nur die Kombinationen für eine bestimmte Zahlungsart zu erhalten.	smallint	3.5.6
ShippingTypeID	NULL	ID einer Versandart. Optionaler Filter, um nur die Kombinationen für eine bestimmte Versandart zu erhalten.	tinyint	3.5.6

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
PaymentForShippingID	ID einer Zahlungsart-Versandart-Kombination, genauer der Kombination aus „PaymentTypeID“ und „ShippingTypeID“	smallint	3.5.0
PaymentForShippingDescription	Bezeichnung der Zahlungsart-Versandart-Kombination „PaymentForShippingID“	varchar(100)	3.5.0
DescriptionForAdmin	Bezeichnung der „PaymentForShippingID“ für den Administrator. Hintergrund : Kombinationen, die von der Bezeichnung her identisch sind, und für einen Administrator bei Konfigurierungen nicht auseinander zu halten wären.	varchar(100)	3.5.22
DetailedDescription	Ausführliche Beschreibung der Zahlungsart-Versandart-Kombination für den Kunden	text	3.5.0
TranslatedDescription	Übersetzung von „PaymentForShippingDescription“ in der durch „LanguageID“ angegebenen Sprache („NULL“, falls keine Übersetzung existiert)	varchar(100)	3.5.0
TranslatedDetailedDescription	Übersetzung von „DetailedDescription“ in der durch „LanguageID“ angegeben Sprache („NULL“, falls keine Übersetzung existiert)	text	3.5.0
ShippingTypeID	ID einer Versandart, die mit der Zahlungsart „PaymentTypeID“ kombiniert werden kann	tinyint	3.5.0
ShippingTypeDescription	Bezeichnung der Versandart „ShippingTypeID“	varchar(100)	3.5.0
PaymentTypeID	ID einer Zahlungsart, die mit der Versandart „ShippingTypeID“ kombiniert werden kann	smallint	3.5.0
PaymentTypeDescription	Bezeichnung der Zahlungsart „PaymentTypeID“	varchar(100)	3.5.0

Sortierung der Rückgabe

(parameterunabängige Sortierung)

PaymentForShippingID (aufsteigend)

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	nur 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.2	2011-06-08	Nur neu übersetzt, um sicherzugehen, daß die Prozedur nicht von den Änderungen rund um „Surcharges“ betroffen ist
4.0.14	2004-06-03	1. 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
3.5.22	2002-08-30
3.5.6	2001-04-17
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_GetPaymentForShipping_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetPaymentForShipping_Ad?LanguageID=<value>'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetPaymentForShipping_Ad?LanguageID=<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_GetPaymentForShipping_Ad',
		array(
			'LanguageID' => <value>,
			// 'PaymentTypeID' => NULL,
			// 'ShippingTypeID' => 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_GetPaymentForShipping_Ad">
			<Parameters>
				<Parameter Name="LanguageID"><!-- tinyint value --></Parameter>
				<!-- <Parameter Name="PaymentTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="ShippingTypeID">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