Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:om_getordersurchargeinfo_ad

om_GetOrderSurchargeInfo_Ad

Gibt zusätzliche Informationen zu Aufschlägen oder Rabatten („Surcharges“) eines Auftrags aus.

HTTP-MethodGET
HTTP-AuthOptional
Aliasom_GetOrderSurchargeInformation_Ad
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
OrderID ID eines Auftrags im „dStore“, zu dessen „Surcharges“ die hinterlegten Informationen ermittelt werden sollen
integer6.0.2
PositionNoNULL Positions-Nummer eines „OrderSurcharges“. Falls angegeben, werden nur die Informationen zu diesem „Surcharge“ (des Auftrags „OrderID“) ermittelt.
tinyint6.0.2
InformationTypeIDNULL ID eines Informations-Typs (für „OrderSurcharges“). Wenn angegeben, werden nur der Datensätze dieses Informations-Typs zurückgegeben.
smallint6.0.2

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
PositionNo(Eindeutige) Positions-Nummer eines „OrderSurcharges“. Gibt die Reihenfolge an, in der die „Surcharges“ errechnet wurden.
integer6.0.2
InformationTypeIDID eines Informationstyps, also um was es sich bei der Zusatz-Information „Information“ handelt (mögliche Werte s. om_GetOrderSurchInfoTypes_Ad)
smallint6.0.2
InformationTypeBezeichnung der „InformationTypeID“
varchar(100)6.0.2
InformationDie zum durch „PositionNo“ (eindeutig) gekennzeichneten „OrderSurcharge“ hinterlegte Information zur Informations-Art „InformationTypeID“
varchar(250)6.0.2
CreatedAtDateAndTimeWann wurde die Information „Information“ zum „OrderSurcharge“ hinterlegt ?
datetime6.0.2
CreatedByUserIDID des „dStore“-Benutzers (der in „UserInfo“ registriert ist) der die Information hinterlegt hat
smallint6.0.2
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • PositionNo (aufsteigend)
  • InformationTypeID (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 Parameterdirekt 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-29Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
6.0.2 2011-06-08Erstmalig 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_GetOrderSurchargeInfo_Ad?OrderID=<value>'

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetOrderSurchargeInfo_Ad?OrderID=<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_GetOrderSurchargeInfo_Ad',
		array(
			'OrderID' => <value>,
			// 'PositionNo' => NULL,
			// 'InformationTypeID' => 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_GetOrderSurchargeInfo_Ad">
			<Parameters>
				<Parameter Name="OrderID"><!-- integer value --></Parameter>
				<!-- <Parameter Name="PositionNo">NULL</Parameter> -->
				<!-- <Parameter Name="InformationTypeID">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_getordersurchargeinfo_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)