mi_GetLicenceKeyData [dstore]

Inhaltsverzeichnis

mi_GetLicenceKeyData

mi_GetLicenceKeyData

Wir ermitteln alle „Kennzahlen“, die die Lizenzart der „dStore SmartSuite“- bzw. „dStore agora“-Instanz bestimmen.

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

Parameter

Die Prozedur hat keine Parameter.

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp¹⁾	ab Version
LicenceParameter	Eine „Kennzahl“ wie z.B. „NumberOfPersons“ oder „NumberOfOrders“	varchar(50)	6.0.0
CurrentValue	Der aktuelle Wert für die Kennzahl „LicenceParameter“. Ist „NULL“, wenn der Benutzer (der diese Prozedur aufruft) nicht über genügend Rechte verfügt, den Wert einsehen zu dürfen. In „Comment“ steht dann, welche Rechte fehlen.	varchar(100)	6.0.0
CurrentDateAndTime	Der aktuelle Zeitpunkt (der Ausführung dieser Prozedur und damit der Ermittlung der Kennzahlen). Hinweis : Dient der leichteren Nachvollziehbarkeit falls die Kennzahlen irgendwo historisch aufgezeichnet werden sollen.	datetime	6.0.0
UnderlyingTimePeriod	Falls die der ermittelten Kennzahl zugrunde liegenden Daten auf eine bestimmte Zeit-Periode eingeschränkt wurden, steht hier eine ensprechende Angabe der Art „last 30 days“ oder „period 03/01/2009 - 03/31/2009“ - sonst „NULL“	varchar(100)	6.0.0
Comment	Hinweise zum „LicenceParameter“. Derzeit nur gefüllt, wenn der Benutzer (der diese Prozedur aufruft) nicht über genügend Rechte verfügt, den Wert zum „LicenceParameter“ einsehen zu dürfen (hier steht dann, welche Rechte fehlen).	varchar(255)	6.5.2

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	direkt und 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	„Start-/Finish-Procedure“-Logik eingebaut, s. Ticket #3670
6.5.2	2013-02-26	1. Ab jetzt werden bestimmte Werte nur geliefert, wenn der Aufrufer entsprechende Ausführungsrechte besitzt 2. Neue Rückgabespalte „Comment“, in der evtl. Auskunft über fehlende Rechte gegeben wird
6.5.1	2012-11-02	Neuer „LicenceParameter“: „TotalOrderNetValue“
6.0.0	2010-03-26	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_GetLicenceKeyData im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ³⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetLicenceKeyData' | 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_GetLicenceKeyData'
);
 
$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_GetLicenceKeyData">
			<Parameters/>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

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