mi_GetUnits_Ad [dstore]

Inhaltsverzeichnis

mi_GetUnits_Ad

mi_GetUnits_Ad

Gibt im „dStore“ definierte Einheiten zurück.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[mi, Get, Units, Ad]
Engine-Kategorie	basics
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
UnitID	NULL	ID einer Einheit, die im „dStore“ definiert ist - wenn angegeben, wird nur der Datensatz dieser Einheit zurückgegeben. Ist „UnitCategoryID“ NICHT „NULL“, wird dieser Parameter ignoriert !	tinyint	3.5.0
UnitCategoryID	NULL	ID einer Kategorie für Einheiten (z.B. „1“ für „Währung“). Ist hierfür ein Wert angegeben (also nicht „NULL“), befinden sich in der Rückgabemenge nur Einheiten, die dieser Kategorie zugeordnet sind - „UnitID“ UND „Active“ werden dann ignoriert !	tinyint	3.5.0
Active	NULL	Nur Einheiten ausgegeben, deren „Active“-Status diesem Wert entspricht (wird nicht beachtet, falls „UnitCategoryID“ angegeben wurde !). Mögliche Werte : „NULL“ (keine Einschränkung), „0“ (inaktiv), „1“ (für alle sichtbar), „2“ (nur für Admins sichtbar)	tinyint	3.5.20

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
UnitID	ID einer Einheit, die im „dStore“ definiert ist	tinyint	3.5.0
UnitSymbol	Symbol (im Regelfall der ISO-Code) für die Einheit „UnitID“	varchar(10)	3.5.0
UnitDescription	Bezeichnung der Einheit „UnitID“	varchar(80)	3.5.0
TriangleConvert	„1“ : Umrechnungen in andere Einheiten (der gleichen Kategorie) müssen u.U. über eine dritte Einheit stattfinden. Beispiel für eine „Dreiecks“-Umrechnung war die Übergangszeit vor dem Euro (z.B. DEM =⇒ EUR =⇒ ÖS) „0“ : Keine „Dreiecks-Umrechnung“ nötig	bit	3.5.0
UnitCategoryID	ID einer Kategorie (z.B. „1“ für „Währung“), zu der die Einheit „UnitID“ gehört	tinyint	3.5.0
UnitCategoryDescription	Bezeichnung der Kategorie „UnitCategoryID“ (z.B. „Währung“).	varchar(100)	3.5.0
Active	„0“ : „UnitID“ wird nicht mehr verwendet, muß aber noch gespeichert werden, da abhängige Datensätze (wie Aufträge) existieren (z.B. die Währung „DEM“) „1“ : „UnitID“ ist aktiv, wird also verwendet „2“ : „UnitID“ ist nur für Administratoren sichtbar	tinyint	3.5.20

Sortierung der Rückgabe

(parameterunabängige Sortierung)

UnitCategoryID (aufsteigend)
UnitDescription (aufsteigend)

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	nur 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]
5.1.1	2006-04-05	1. Rückgabespalte „Active“ fehlte in einem Fall 2. Fehler in der Doku : die Spalte „Active“ war gar nicht erwähnt ! 3. Rückgabemenge wurde nicht wie dokumentiert sortiert !
4.0.14	2004-06-03	1. Aufruf der Prozeduren „_mi_StartProcedure“, „_mi_FinishProcedure“ und „_mi_ChooseParamValueSeperator“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur 3. Konsequente Fehlerbehandlung
3.5.20	2002-07-22
3.5.0	2000-11-23	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:

mi_GetUnits_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetUnits_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'),
	'mi_GetUnits_Ad',
		array(
			// 'UnitID' => NULL,
			// 'UnitCategoryID' => NULL,
			// 'Active' => 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="mi_GetUnits_Ad">
			<Parameters>
				<!-- <Parameter Name="UnitID">NULL</Parameter> -->
				<!-- <Parameter Name="UnitCategoryID">NULL</Parameter> -->
				<!-- <Parameter Name="Active">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