fo_GetForumStatistics_Ad [dstore]

Inhaltsverzeichnis

fo_GetForumStatistics_Ad

fo_GetForumStatistics_Ad

Gibt ein paar statistische Informationen zu einem Forum (oder mehreren Foren) zurück.

Erläuterung des Parameters „ListOfStatisticInformationIDs“:
Gibt an, welche Informationen man haben möchte…
„1“ : „NumberOfThreads“
„2“ : „NumberOfPostings“
„4“ : „NumberOfNotApprovedPostings“
„5“ : „PostDateOfLatestThread“
„6“ : „PostDateOfLatestPosting“
„7“ : „PostDateOfEarliestThread“
„8“ : „PostDateOfEarliestPosting“
„9“ : „LatestPostingID“
„10“ : „EarliestPostingID“

Anmerkungen :
1. Seit Version 4.0.2 werden nicht mehr nur sichtbare Beiträge (d.h. mit einem „Visible“-Status von „4“ oder „8“) berücksichtigt, sondern die Beiträge mit einem „Visibility“ entsprechenden Status
2. Falls sowohl für „FromDate“ als auch „ToDate“ der Wert „NULL“ übergeben wird, werden zu den Informationen „NumberOfThreads“, „NumberOfPostings“ und „NumberOfNotApprovedPostings“ die AKTUELLEN Werte (also Stand zum Zeitpunkt des Aufrufs dieser Prozedur) ermittelt !

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

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
ForumID		ID eines Forums. Wird „NULL“ angegeben, werden die „ForumID“s in „tempdb.dbo.OneID“ erwartet.	smallint	3.5.21
ListOfStatisticInformationIDs	NULL	Gibt an, welche Informationen man haben möchte. Liste von IDs, die durch '¶' voneinander getrennt sind. Welche IDs übergeben werden können und welche Bedeutung sie haben, ist in der Beschreibung der Prozedur dokumentiert. „NULL“ um alle zu bekommen.	varchar(100)	3.5.21
FromDate	NULL	Wenn die statistischen Daten nur in einem bestimmten Zeitraum ermittelt werden sollen, kann man diesen durch „FromDate“ (Beginn) und „ToDate“ (Ende) angeben - es ist auch möglich, nur einen der beiden Parameter anzugeben	datetime	3.5.21
ToDate	NULL	Wenn die statistischen Daten nur in einem bestimmten Zeitraum ermittelt werden sollen, kann man diesen durch „FromDate“ (Beginn) und „ToDate“ (Ende) angeben - es ist auch möglich, nur einen der beiden Parameter anzugeben	datetime	3.5.21
DateFormat	'English'	Gibt an, wie die Werte in der Rückgabemenge formatiert werden sollen, wenn es Datumsangaben sind (Groß- und Kleinschreibung wird nicht beachtet) : 'english' oder 'england' : „mm/dd/yyyy hh:mi:ss“ 'german' oder 'germany' : „dd.mm.yyyy hh:mi:ss“	varchar(20)	3.5.21
Visibility	12	Nur Postings beachten, die einen bestimmten „Sichtbarkeitsstatus“ („Visible“ in „ForumPostings“) haben; für eine Filterung nach mehreren „Visible“-Status gibt man einfach die entsprechende Summe an. Mögliche Werte : siehe fo_GetPostingVisibilities.	tinyint	4.0.2

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
StatisticInformationID	Eine ID, die in „ListOfStatisticInformationIDs“ übergeben wurde und angibt, welche Information man haben möchte (siehe Beschreibung)	tinyint	3.5.21
StatisticInformation	Bezeichnung der Information „StatisticInformationID“	varchar(100)	3.5.21
Value	Der statistische Wert des Forums „ForumID“ zur Information „StatisticInformationID“	varchar(100)	3.5.21
ForumID	ID des Forums, auf das sich „Value“ bezieht - also entweder „ForumID“ oder die ID eines Forums, das durch „tempdb.dbo.OneID“ übergeben wurde	smallint	3.5.21

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	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	Anpassungen an aktuellen Code-Standard
6.5.3	2013-03-18	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
4.0.10	2004-03-15	1. Aufruf der Prozeduren „_mi_StartProcedure“ und „_mi_FinishProcedure“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
4.0.2	2003-06-11	1. Neuer Parameter „Visibility“ 2. Fehlender Hinweis in der Doku auf die Tatsache, daß bei Angabe von „NULL“ sowohl für „FromDate“ als auch für „ToDate“ zu einigen Informationen die AKTUELLEN Werte ermittelt werden !
3.5.21	2002-08-06	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:

fo_GetForumStatistics_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/fo_GetForumStatistics_Ad?ForumID=<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'),
	'fo_GetForumStatistics_Ad',
		array(
			'ForumID' => <value>,
			// 'ListOfStatisticInformationIDs' => NULL,
			// 'FromDate' => NULL,
			// 'ToDate' => NULL,
			// 'DateFormat' => 'English',
			// 'Visibility' => 12
		)
);
 
$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="fo_GetForumStatistics_Ad">
			<Parameters>
				<Parameter Name="ForumID"><!-- smallint value --></Parameter>
				<!-- <Parameter Name="ListOfStatisticInformationIDs">NULL</Parameter> -->
				<!-- <Parameter Name="FromDate">NULL</Parameter> -->
				<!-- <Parameter Name="ToDate">NULL</Parameter> -->
				<!-- <Parameter Name="DateFormat">'English'</Parameter> -->
				<!-- <Parameter Name="Visibility">12</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