st_GetPHStatistics_Ad [dstore]

Inhaltsverzeichnis

st_GetPHStatistics_Ad

st_GetPHStatistics_Ad

Gibt (stundengenaue) Statistiken aus der Tabelle „DailyCharacteristicNos_PH“ aus.

Anmerkung :
Für jede volle Stunde im Zeitraum „FromDate“ bis „ToDate“ wird eine Ergebniszeile zurückgeliefert - auch wenn gar kein Datensatz in „DailyCharacteristicNos_PH“ vorhanden sein sollte !

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

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
FromDateAndTime		Start-Zeitpunkt des zu untersuchenden Zeitraums	datetime	3.5.0
ToDateAndTime	NULL	End-Zeitpunkt des zu untersuchenden Zeitraums. Wird „NULL“ angegeben, dann werden alle vorhandenen Statistiken ab „FromDate“ berücksichtigt.	datetime	3.5.0
BasicCharacteristicNumbers	NULL	Liste, die IDs von Basis-Kennzahlen (durch '¶' getrennt) enthält, zu denen Statistiken ermittelt werden sollen (mögliche Werte : s. st_GetBasicCharacteristics_Ad). Falls „NULL“ übergeben wird, gibt die Prozedur Statistiken zu allen Basis-Kennzahlen aus.	varchar(255)	3.5.0

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
Time⁵⁾	Heißt seit Version 4.0.0 „DateAndTime“	datetime	3.5.0
BCN⁶⁾	Heißt seit Version 4.0.0 „BasicCharacteristicNumber“	tinyint	3.5.0
DateAndTime	Ein (stundengenauer) Zeitpunkt im angegebenen Zeitraum „FromDate“ bis „ToDate“	datetime	4.0.0
BasicCharacteristicNumber	Nummer einer Basis-Kennzahl	tinyint	4.0.0
BasicCharacteristic	Kurzbezeichnung der Basis-Kennzahl „BasicCharacteristicNumber“	varchar(25)	4.0.0
Description	Beschreibung der Basis-Kennzahl „BasicCharacteristicNumber“	varchar(100)	4.0.0
Value	Die gespeicherte statistische Information zur Basis-Kennzahl „BasicCharacteristicNumber“; z.Zt. entweder eine Anzahl (für die Basis-Kennzahl „Views“ z.B.) oder ein Betrag in der Standardwährung (für die Basis-Kennzahl „Bestellumsatz“)	decimal(12,2)	3.5.0

Sortierung der Rückgabe

(parameterunabängige Sortierung)

DateAndTime (aufsteigend)
BasicCharacteristicNumber (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
-502	Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)	nur indirekt
-500	Falsche Parameter	direkt und 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	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
4.0.15	2004-07-30	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
4.0.0	2003-04-03	1. Änderungen eines Rückgabespalten-Namens 2. Hinzufügen einiger Rückgabespalten 3. Dokumentation der Rückgabemenge 4. Ab jetzt : „-500“, falls in „BasicCharacteristicNumbers“ Werte sind, die nicht existieren 5. Komplette Überarbeitung des Quellcodes
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:

st_GetPHStatistics_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/st_GetPHStatistics_Ad?FromDateAndTime=<value>'

Mit xmllint ⁸⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/st_GetPHStatistics_Ad?FromDateAndTime=<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'),
	'st_GetPHStatistics_Ad',
		array(
			'FromDateAndTime' => <value>,
			// 'ToDateAndTime' => NULL,
			// 'BasicCharacteristicNumbers' => 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="st_GetPHStatistics_Ad">
			<Parameters>
				<Parameter Name="FromDateAndTime"><!-- datetime value --></Parameter>
				<!-- <Parameter Name="ToDateAndTime">NULL</Parameter> -->
				<!-- <Parameter Name="BasicCharacteristicNumbers">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾ , ⁶⁾

Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.

⁷⁾

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