om_GetOrderSurchargeInfo_Pu [dstore]

Inhaltsverzeichnis

om_GetOrderSurchargeInfo_Pu

om_GetOrderSurchargeInfo_Pu

Gibt zusätzliche Informationen zu Aufschlägen oder Rabatten („Surcharges“) eines Auftrags aus, sofern der Auftraggeber identifiziert werden kann.

HTTP-Method	GET
HTTP-Auth	Optional
Alias	om_GetOrderSurchargeInformation_Pu
Tags	[om, Get, Order, Surcharge, Information, Pu]
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
OrderID		ID eines Auftrags im „dStore“, zu dessen „Surcharges“ die hinterlegten Informationen ermittelt werden sollen	integer	6.0.2
PersonIdentificationValues		Liste (durch '¶' getrennt) von Werten, die den Auftraggeber identifizieren. Diese Werte müssen Eigenschaften zu den Merkmal-IDs sein, die in „PersonTypeSettings“ zur „PersonTypeID“ zum Schlüssel „PersonIdentificationIDs“ hinterlegt sind.	varchar(255)	6.0.2
PersonTypeID	1	ID des Personen-Typs dem die zu identifizierende Person angehört. Dieser muß bei einer Identifizierung immer mit angegeben werden, da die Merkmale zur Identifizierung pro Personentyp variieren können.	tinyint	6.0.2
PositionNo	NULL	Positions-Nummer eines „OrderSurcharges“. Falls angegeben, werden nur die Informationen zu diesem „Surcharge“ (des Auftrags „OrderID“) ermittelt.	tinyint	6.0.2
InformationTypeID	NULL	ID eines Informations-Typs (für „OrderSurcharges“). Wenn angegeben, werden nur der Datensätze dieses Informations-Typs zurückgegeben.	smallint	6.0.2

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
PositionNo	(Eindeutige) Positions-Nummer eines „OrderSurcharges“. Gibt die Reihenfolge an, in der die „Surcharges“ errechnet wurden.	integer	6.0.2
InformationTypeID	ID eines Informationstyps, also um was es sich bei der Zusatz-Information „Information“ handelt (mögliche Werte s. om_GetOrderSurchInfoTypes_Ad)	smallint	6.0.2
InformationType	Bezeichnung der „InformationTypeID“	varchar(100)	6.0.2
Information	Die zum durch „PositionNo“ (eindeutig) gekennzeichneten „OrderSurcharge“ hinterlegte Information zur Informations-Art „InformationTypeID“	varchar(250)	6.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 ⁵⁾
-660	Identifikation fehlgeschlagen	nur indirekt
-621	Fehlender oder falscher Eintrag in PersonTypeSettings	nur indirekt
-599	Lizenz ist ungültig oder abgelaufen	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
-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	„Start-/Finish-Procedure“-Logik eingebaut, s. Ticket #3670
6.0.2	2011-06-08	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_GetOrderSurchargeInfo_Pu im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetOrderSurchargeInfo_Pu?OrderID=<value>&PersonIdentificationValues=<value>'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetOrderSurchargeInfo_Pu?OrderID=<value>&PersonIdentificationValues=<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_Pu',
		array(
			'OrderID' => <value>,
			'PersonIdentificationValues' => '<value>',
			// 'PersonTypeID' => 1,
			// '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_Pu">
			<Parameters>
				<Parameter Name="OrderID"><!-- integer value --></Parameter>
				<Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="PersonTypeID">1</Parameter> -->
				<!-- <Parameter Name="PositionNo">NULL</Parameter> -->
				<!-- <Parameter Name="InformationTypeID">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