om_ModifyPayForShipDescr_Ad [dstore]

Inhaltsverzeichnis

om_ModifyPayForShipDescr_Ad

om_ModifyPayForShipDescr_Ad

Prozedur, um Übersetzungen der Bezeichnung bzw. Beschreibung einer Zahlungs-Versandart-Kombination zu verwalten.

Hinweise :

1. Zu einer Zahl-/Versandart-Kombination gibt es immer zwei Beschreibungs-Felder, nämlich „PaymentForShippingDescription“ und „DetailedDescription“. Für ersteres dient der gleichnamige Parameter, das zweite Feld kann man durch entsprechende Übergabe via „tempdb.dbo.TextData“ füllen. Da beides KEINE Pflichtfelder sind, kann „PaymentForShippingDescription = NULL“ oder „tempdb.dbo.TextData“ leer sein - sind aber beide Werte nicht angegeben, gibt es den Fehler „-500“…

2. „LanguageID“ darf nicht die „DefaultLanguageID“ aus „Settings“ sein - weil die Beschreibungen zur Standardsprache immer in den „Master“-Tabellen (in dem Fall also „PaymentForShipping“) sind.

HTTP-Method	POST
HTTP-Auth	Optional
Alias	om_ModifyPaymentForShippingDescription_Ad
Tags	[om, Modify, Payment, For, Shipping, Description, Ad]
Engine-Kategorie	configurations
Engine-Typ	Daten-Änderung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
PaymentForShippingID		ID einer Zahlungsart-Versandart-Kombination	smallint	3.5.12
LanguageID		ID der Sprache, in der die Bezeichnung bzw. Beschreibung der Zahlungs-Versandart-Kombination „PaymentForShippingID“ übersetzt werden soll	tinyint	3.5.12
PaymentForShippingDescription		Die Bezeichnung der „PaymentForShippingID“ in der durch „LanguageID“ angegebenen Sprache. Die Übersetzung der Beschreibung ist via „tempdb.dbo.TextData“ zu übergeben. Ist „DeleteTranslation = 0“, muß wenigstens die Bez. oder die Beschr. angegeben sein.	varchar(100)	3.5.12
DeleteTranslation	0	„0“ : Eine Übersetzung soll angelegt bzw .geändert werden „1“ : Die Übersetzung der Bezeichnung und der Beschreibung in der durch „LanguageID“ angegeben Sprache wird gelöscht	bit	3.5.12

Rückgabe

Die Prozedur hat keine Rückgaben.

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁴⁾
-621	Fehlender oder falscher Eintrag in PersonTypeSettings	nur indirekt
-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
-550	Fehlender oder falscher Eintrag in Settings	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
-502	Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)	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

7.0.7	2015-01-29	Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
6.5.4	2013-04-29	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
4.0.14	2004-06-03	1. Aufruf der Prozeduren „_mi_StartProcedure“, „_mi_FinishProcedure“ und „_mi_ChooseParamValueSeperator“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur 3. Konsequente Fehlerbehandlung
3.5.12	2001-10-17	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_ModifyPayForShipDescr_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifyPayForShipDescr_Ad?PaymentForShippingID=<value>&LanguageID=<value>&PaymentForShippingDescription=<value>'

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/om_ModifyPayForShipDescr_Ad?PaymentForShippingID=<value>&LanguageID=<value>&PaymentForShippingDescription=<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_ModifyPayForShipDescr_Ad',
		array(
			'PaymentForShippingID' => <value>,
			'LanguageID' => <value>,
			'PaymentForShippingDescription' => '<value>',
			// 'DeleteTranslation' => 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_ModifyPayForShipDescr_Ad">
			<Parameters>
				<Parameter Name="PaymentForShippingID"><!-- smallint value --></Parameter>
				<Parameter Name="LanguageID"><!-- tinyint value --></Parameter>
				<Parameter Name="PaymentForShippingDescription"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="DeleteTranslation">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