om_GetOrderInformationTypes_Ad [dstore]

Inhaltsverzeichnis

om_GetOrderInformationTypes_Ad

om_GetOrderInformationTypes_Ad

Gibt Typen von Informationen zurück, die zu einem Auftrag (in „OrderInformation“) hinterlegt werden können.

Hinweis zum Parameter „PersonCharacteristicID“ :

Falls die ID für den aufrufenden Benutzer (komplett) lesend gesperrt ist (s. pm_GetPChAccRestrForUsers_Ad), führt dies zu einer leeren Ergebnismenge !

Hinweis zur Rückgabespalte „PersonCharacteristicID“ :

Hier kann nicht nur deswegen „NULL“ zurückkommen, weil zur „OrderInformationTypeID“ kein zugehöriges Personen-Merkmal konfiguriert ist, sondern auch, weil das Merkmal (komplett) lesend für den aufrufenden Benutzer gesperrt ist (s. pm_GetPChAccRestrForUsers_Ad) !

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[om, Get, Order, Information, Types, Ad]
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
InformationTypeID	NULL	ID eines Informations-Typs (für Aufträge). Wenn angegeben, wird nur der Datensatz dieses Informations-Typs zurückgegeben.	smallint	3.5.6
PersonCharacteristicID	NULL	ID eines Personen-Merkmals, nach dem gefiltert werden soll. Hintergrund : Man möchte im Auftrag die Eigenschaft des Auftraggebers zu diesem Merkmal zum Zeitpunkt der Auftragserstellung speichern (denn die Personen-Eigenschaft könnte ja geändert werden !)	smallint	3.5.6

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
OrderInformationTypeID	ID eines Informations-Typs	smallint	3.5.6
InformationType	Bezeichnung der „OrderInformationTypeID“	varchar(100)	3.5.6
PersonCharacteristicID	ID eines Merkmals, das zur „OrderInformationTypeID“ 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	3.5.6
CharacteristicDescription	Bezeichnung des Merkmals „PersonCharacteristicID“	varchar(100)	3.5.6
FieldTypeID	ID eines „Feld-Typs“, von dem alle Informationen des Typs „OrderInformationTypeID“ sein müssen (z.B. „Text mit maximal 20 Zeichen“)	tinyint	5.5.0

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-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	direkt und indirekt
-500	Falsche Parameter	nur 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	1. Beachtung der neuen Zugriffs-Beschränkungen für Merkmale [⇒ Doku-Anpassung] 2. Anpassung des Quellcodes an den aktuellen Standard
5.5.0	2008-01-07	Neue Rückgabespalte „FieldTypeID“
4.0.12	2004-04-30	1. Aufruf der Prozeduren „_mi_StartProcedure“ und „_mi_FinishProcedure“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn 3. Ein Spaltenname war falsch benannt, und eine Rückgabespalte war in der Doku falsch benannt !
3.5.6	2001-04-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_GetOrderInformationTypes_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetOrderInformationTypes_Ad'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetOrderInformationTypes_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_GetOrderInformationTypes_Ad',
		array(
			// 'InformationTypeID' => NULL,
			// 'PersonCharacteristicID' => 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_GetOrderInformationTypes_Ad">
			<Parameters>
				<!-- <Parameter Name="InformationTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="PersonCharacteristicID">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