om_GetOrderInformation_Pu [dstore]

Inhaltsverzeichnis

om_GetOrderInformation_Pu

om_GetOrderInformation_Pu

Gibt zusätzliche Informationen zu einer Bestellung aus.

Anmerkung zum Parameter „PersonIdentificationValues“ :

Alle zusätzlich zum Auftrag hinterlegten Informationen können nur eingesehen werden, wenn die durch diesen Parameter angegebenen Daten den Auftraggeber (Person vom Typ „PersonTypeID“) identifizieren !

Sind KEINE Identifizierungsdaten angegeben („NULL“), können trotzdem Informationen zu einem Auftrag abgefragt werden - natürlich nur solche, die „unsensibel“ sind ! Welche „InformationTypeID“s auch ohne Identifizierung angezeigt werden dürfen, legt ein „Settings“-Eintrag fest, nämlich : „OrderInformationTypeIDsVisibleForPublicUsers“.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[om, Get, Order, 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, zu dem man sich die hinterlegten (Zusatz-)Informationen anzeigen lassen möchte. Wird „NULL“ übergeben, muß „OrderCode“ angegeben sein !	integer	4.0.12
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)	4.0.12
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	4.0.12
InformationTypeID	NULL	(Optional) ID eines Informations-Typs, um nur die Information diesen Typs zu erhalten. Sind KEINE Identifizierungsdaten angegeben, können nur „unsensible“ Daten abgefragt werden : siehe „Settings“-Eintrag zu „OrderInformationTypeIDsVisibleForPublicUsers“.	smallint	4.0.12
OrderCode	NULL	Wenn die „OrderID“ NICHT bekannt ist, kann man hier eine Information angeben, durch die ein Auftrag eindeutig identifiziert wird. Welcher Informationstyp das ist, wird in „Settings“ zum Schlüssel „OrderInformationTypeIDIdentifyingOrder“ definiert.	varchar(1000)	4.0.12

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
OrderID	ID eines Auftrags (also entweder „OrderID“ bzw. die ID des Auftrags zu „OrderCode“)	integer	4.0.12
InformationTypeID	ID eines Informationstyps, also um was es sich bei der Zusatz-Information „Information“ handelt	smallint	4.0.12
InformationType	Bezeichnung der „InformationTypeID“	varchar(100)	4.0.12
PersonCharacteristicID	ID 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 !)	smallint	4.0.12
Information	Die zum Auftrag „OrderID“ hinterlegte Information	varchar(1000)	4.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 ⁵⁾
-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
-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
-371	Die angegebene Information gehört nicht eindeutig zu einem bestimmten Auftrag	nur direkt
-343	Nicht öffentliche Informationen zum Auftrag können nur vom Auftraggeber/Administrator erfragt werden	nur direkt

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]
7.0.5	2014-05-26	Datentyp des Parameters „OrderCode“ erweitert und Dokumentation bzgl. des Datentyps der Ergebnisspalte „Information“ angepasst
7.0.4	2014-03-19	„set forceplan off“-Anweisung fehlte an einer Stelle
6.5.4	2013-04-29	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
5.1.5	2006-08-29	Explizites „ORDER BY“ eingefügt, um die Sortierung der Rückgabemenge zu garantieren
4.0.12	2004-04-30	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_GetOrderInformation_Pu im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

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