Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:om_getorderinformation_ad

om_GetOrderInformation_Ad

Gibt zusätzliche Informationen zu einer (oder mehreren) Bestellung(en) aus.

HTTP-MethodGET
HTTP-AuthOptional
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
OrderIDNULL ID eines Auftrags, zu dem man sich die hinterlegten (Zusatz-)Informationen anzeigen lassen möchte. Wird „NULL“ übergeben, erwartet die Prozedur „OrderID“s in „tempdb.dbo.OneID“.
integer4.0.12
InformationTypeIDNULL ID eines Informations-Typs (für Aufträge). Wenn angegeben, wird nur die Zusatz-Information zu diesem Typ zurückgegeben
smallint4.0.12

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
OrderIDID eines Auftrags (also entweder „OrderID“ bzw. eine ID, die in „tempdb.dbo.OneID“ übergeben wurde)
integer4.0.12
InformationTypeIDID eines Informationstyps, also um was es sich bei der Zusatz-Information „Information“ handelt
smallint4.0.12
InformationTypeBezeichnung der „InformationTypeID“
varchar(100)4.0.12
PersonCharacteristicIDID eines Merkmals, das zur „InformationTypeID“ korrespondiert. Hintergrund : Man möchte im Auftrag die Eigenschaft des Auftraggebers zu diesem Merkmal zum Zeitpunkt der Auftragserstellung speichern (denn die Eigenschaft könnte ja geändert werden !)
smallint4.0.12
InformationDie zum Auftrag „OrderID“ hinterlegte Information
varchar(1000)4.0.12
CreatedAtDateAndTimeWann wurde die Information „Information“ zur „OrderID“ hinterlegt ? Anmerkung : Für Daten, die vor dem Einspielen des Updates 4.0.12 angelegt wurden, existiert diese Information nicht - in diesem Fall wird hier „NULL“ zurückgegeben !
datetime4.0.12
CreatedByUserIDID des „dStore“-Benutzers (der in „UserInfo“ registriert ist) der die Information hinterlegt hat. Anmerkung : Für Daten, die vor dem Einspielen des Updates 4.0.12 angelegt wurden, existiert diese Information nicht - in diesem Fall steht hier „NULL“ !
smallint4.0.12
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • OrderID (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 Parameternur 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]
7.0.5 2014-05-26Dokumentation bzgl Datentyp der Rückgabespalte „Information“ angepasst
5.1.5 2006-08-29Explizites „ORDER BY“ eingefügt, um die Sortierung der Rückgabemenge zu garantieren
4.0.12 2004-04-30Erstmalig 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_GetOrderInformation_Ad'

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetOrderInformation_Ad' | 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_GetOrderInformation_Ad',
		array(
			// 'OrderID' => 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_GetOrderInformation_Ad">
			<Parameters>
				<!-- <Parameter Name="OrderID">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_getorderinformation_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)