engine:procedures:fo_getforumstatistics_pu
Inhaltsverzeichnis
fo_GetForumStatistics_Pu
Gibt ein paar statistische Informationen zu einem Forum (oder seit dieser Version auch zu mehreren Foren) zurück, sofern die identifizierte Person entsprechende Lese-Rechte besitzt.
Anmerkung : Falls die Identifizierung fehlschlägt oder in „UniqueID“ der Wert „defaultUniqueID“ angegeben wird, wird die anonyme Person (mit der speziellen „PersonID = 0“) gewählt.
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“ : „PostDateOfErliestPosting“
„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 | |
| Engine-Kategorie | forums |
| Engine-Typ | Daten-Ermittlung |
| Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Parameter
| Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
|---|---|---|---|---|
| PersonIdentificationValues | Liste von Werten, die den Forum-Teilnehmer identifizieren. Diese Werte müssen Eigenschaften zu den Merkmal-IDs sein, die in „PersonTypeSettings“ zur „PersonTypeID“ zum Schlüssel „PersonIdentificationIDs“ hinterlegt sind. | varchar(255) | 3.5.0 | |
| PersonTypeID | ID des Personen-Typs dem der zu identifizierende Forum-Teilnehmer angehört. Dieser muß bei einer Identifizierung immer mit angegeben werden, da die Merkmale zur Identifizierung pro Personentyp variieren können. | tinyint | 3.5.0 | |
| UniqueID | Eindeutige ID eines Besuchers, die dem zu identifizierenden Forum-Teilnehmer aktuell zugeordnet ist. Falls die Identifizierungsdaten zur Person in „SessionManagement“ (zur „UniqueID“) gespeichert sind, darf „PersonIdentificationValues“ „NULL“ sein. | varchar(50) | 3.5.0 | |
| ForumID | ID eines Forums. Wird „NULL“ angegeben, werden die „ForumID“s in „tempdb.dbo.OneID“ erwartet. | smallint | 3.5.0 | |
| 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.0 |
| 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.0 |
| 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.0 |
| 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.19 |
| 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 |
| SeparatorInIdentVals | '¶' | Gibt an, durch welche Zeichenkette die Werte in „PersonIdentificationValues“ getrennt sind | varchar(4) | 5.5.0 |
Rückgabe
(parameterunabhängig)
| Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
|---|---|---|---|
| StatisticInformationID | Eine ID, die in „ListOfStatisticInformationIDs“ übergeben wurde und angibt, welche Information man haben möchte (siehe Beschreibung) | tinyint | 3.5.0 |
| StatisticInformation | Bezeichnung der Information „StatisticInformationID“ | varchar(100) | 3.5.0 |
| Value | Der statistische Wert des Forums „ForumID“ zur Information „StatisticInformationID“ | varchar(100) | 3.5.0 |
| 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.11 |
Output-Parameter
Die Prozedur hat keine Output-Parameter.
Mögliche Return-Codes
| Code | Beschreibung | Quelle 5) |
|---|---|---|
| -805 | Keine Berechtigung zum Löschen von Postings | nur direkt |
| -802 | Keine Berechtigung zum Bestätigen von Postings des Forums | nur direkt |
| -800 | Kein Zugriff auf das Forum | nur direkt |
| -660 | Identifikation fehlgeschlagen | nur indirekt |
| -621 | Fehlender oder falscher Eintrag in PersonTypeSettings | nur indirekt |
| -602 | Zur defaultUniqueID („VisitorID = -2“) können keinerlei Daten gespeichert oder verändert werden | nur indirekt |
| -599 | Lizenz ist ungültig oder abgelaufen | nur indirekt |
| -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 |
| -550 | Fehlender oder falscher Eintrag in Settings | 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 | „Start-/Finish-Procedure“-Logik eingebaut, s. Ticket #3670 |
| 6.5.3 | 2013-03-18 | Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung |
| 6.5.0 | 2012-09-17 | Holger Wies : Wird in „UniqueID“ die „DefaultUniqueID“ angegeben, wird nun [ohne Aufruf von pm_CheckPersonIdentity_Pu] der Aufrufer als „anonyme Person“ [„PersonID = 0“] identifiziert |
| 5.5.0 | 2008-01-07 | 1. Neuer Parameter „SeparatorInIdentVals“ 2. Bearbeitung des Quellcodes hinsichtlich neuer Konventionen |
| 4.0.3 | 2003-07-10 | Fehler bei der Überprüfung der Rechte [seit dem in der letzen Version eingeführten Parameter „Visibility“] |
| 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 | |
| 3.5.20 | 2002-07-22 | |
| 3.5.19 | 2002-06-17 | |
| 3.5.18 | 2002-05-15 | |
| 3.5.17 | 2002-05-02 | |
| 3.5.11 | 2001-09-06 | |
| 3.5.7 | 2001-05-04 | |
| 3.5.2 | 2001-01-28 | |
| 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:
cURL
Unformatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/fo_GetForumStatistics_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<value>&ForumID=<value>'
Mit xmllint 6) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/fo_GetForumStatistics_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<value>&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_Pu', array( 'PersonIdentificationValues' => '<value>', 'PersonTypeID' => <value>, 'UniqueID' => '<value>', 'ForumID' => <value>, // 'ListOfStatisticInformationIDs' => NULL, // 'FromDate' => NULL, // 'ToDate' => NULL, // 'DateFormat' => 'English', // 'Visibility' => 12, // 'SeparatorInIdentVals' => '¶' ) ); $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_Pu"> <Parameters> <Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter> <Parameter Name="PersonTypeID"><!-- tinyint value --></Parameter> <Parameter Name="UniqueID"><!-- varchar value --></Parameter> <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> --> <!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
6)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/fo_getforumstatistics_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)