om_GetPaymentForShipping_Pu [dstore]

Inhaltsverzeichnis

om_GetPaymentForShipping_Pu

om_GetPaymentForShipping_Pu

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

Anmerkung zu den „Description“-Rückgabespalten :
Wenn keine Daten zur angegebenen „LangaugeID“ ermittelt werden können, wird die entsprechende Beschreibung ebenfalls zur „DefaultLanguageID“ geliefert.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[om, Get, Payment, For, Shipping, Pu]
Engine-Kategorie	order management
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.5 (2014-05-26)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
ShippingTypeID	NULL	ID einer Versandart. Optionaler Filter, um nur die Kombinationen für eine bestimmte Versandart zu erhalten.	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.0
LanguageID	0	ID einer Sprache, in der die Bezeichnungen für Zahlungs- bzw. Versandarten ausgegeben werden sollen	tinyint	3.5.0

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
PaymentForShippingID	ID einer Zahlungsart-Versandart-Kombination	smallint	3.5.9
PaymentForShippingDescription	Bezeichnung der Zahlungsart-Versandart-Kombination „PaymentForShippingID“ - in der Standardsprache bzw. in der durch „LanguageID“ angegebenen Sprache	varchar(100)	3.5.0
DetailedDescription	Ausführliche Beschreibung der Zahlungsart-Versandart-Kombination für den Kunden	text	3.5.9
PaymentTypeDescription	Bezeichnung der Zahlungsart - in der Standardsprache bzw. in der durch „LanguageID“ angegebenen Sprache	varchar(100)	7.0.5
ShippingTypeDescription	Bezeichnung der Versandart - in der Standardsprache bzw. in der durch „LanguageID“ angegebenen Sprache	varchar(100)	7.0.5

Sortierung der Rückgabe

(parameterunabängige Sortierung)

PaymentForShippingID (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-621	Fehlender oder falscher Eintrag in PersonTypeSettings	nur indirekt
-550	Fehlender oder falscher Eintrag in Settings	nur indirekt

XML-Schema

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

Historie

7.0.5	2014-05-26	1. Zusätzlich „PaymentTypeDescription“ und „ShippingTypeDescription“ im Ergebnis 2. An den aktuellen Code-Standard angepasst
3.5.9	2001-06-16
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_Pu im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetPaymentForShipping_Pu' | 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_Pu',
		array(
			// 'ShippingTypeID' => NULL,
			// 'PaymentTypeID' => NULL,
			// 'LanguageID' => 0
		)
);
 
$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_Pu">
			<Parameters>
				<!-- <Parameter Name="ShippingTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="PaymentTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="LanguageID">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