Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:fo_getmainpostings_pu

fo_GetMainPostings_Pu

Gibt zu einem Forum eine Liste von sogenannten „MainPostings“ (oder auch „Threads“) aus. Ein „MainPosting“ ist sozusagen der START-Beitrag einer Kette von Postings („Thread“), der sich also dadurch auszeichnet, daß er KEINE Antwort auf einen anderen Beitrag darstellt (intern gekennzeichnet durch die Eigenschaft „PostingID = MainPostingID“).

Die identifizierte Person muß natürlich über die entsprechenden Rechte für das Forum verfügen. Falls die Identifizierung fehlschlägt oder in „UniqueID“ der Wert „defaultUniqueID“ angegeben wird, werden die Rechte für die anonyme Person (mit der speziellen „PersonID = 0“) gecheckt.

Anmerkungen zum Parameter „Visibility“ :
1. Sofern auch gelöschte Beiträge berücksichtigt werden sollen, muß die identifizierte Person für das Forum mindestens eines der folgenden Rechte besitzen :
„16“ : „löschen eigener Postings, sofern keine Replies vorhanden“
„32“ : „löschen eigener Postings (inkl. Replies)„
„128“ : „löschen aller Postings des Forums, sofern keine Replies vorhanden“
„256“ : „löschen aller Postings des Forums (inkl. Replies)„
Besitzt die Person nur das Recht „16“ oder „32“ werden zudem nur die EIGENEN (Author entspricht der identifizierten Person) gelöschten Beiträge ausgegeben !
2. Sollen nicht bestätigte Beiträge berücksichtigt werden, benötigt die identifizierte Person das Recht
„64“ : „bestätigen von Postings des Forums“
für das Forum.

Anmerkung zur Rückgabespalte „AlreadyRead“ :
In „ForumSettings“ gibt es einen Eintrag „HoursAfterPostingsAreRegardedAsRead“, der angibt, ab wann ein Posting IMMER als gelesen gilt (einfach weil es in einem gewissen Sinn „alt“ ist). Falls „MaintainReadPostingsPerPerson“ für das angegebene Forum (in „ForumSettings“) auf „1“ steht, wird von jeder Prozedur, die Postings inkl. „Body“ ausgibt, in der Tabelle „ReadPostingsPerPerson“ festgehalten, welche Person welches Posting schon gelesen hat.
⇒ Wurde das Posting vor „HoursAfterPostingsAreRegardedAsRead“ Stunden verfaßt ODER gibt es zur Person, die diese Prozedur aufruft, einen Eintrag in „ReadPostingsPerPerson“, ist „AlreadyRead = 1“.

Anmerkung zu den Rückgabespalten „PostingsInThread“ und „NewPostingsInThread“ :
Es werden nur die Antworten berücksichtigt (also nicht das „MainPosting“ selbst) !

HTTP-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategorieforums
Engine-TypDaten-Ermittlung
Letzte Aktualisierung7.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.9
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.
tinyint3.5.9
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.9
ForumID ID eines Forums. Hinweis : Datentyp muß eigentlich ein „smallint“ sein. Aufgrund der Abwärtskompatibilität bleibt dies zwar so, aber es gibt “-500“, falls Werte außerhalb des Wertebereichs “-32768 bis 32767“ übergeben werden.
integer3.5.9
SortCriteria0 Wird nur beachtet, wenn „SortingCriteriaNo“ NICHT „NULL“ ! Es wird nach dem „Thread-Datum“ sortiert (auf-/absteigend, s. „ReverseOrderOfSorting“). Hiermit definiert man „Thread-Datum“ :
„0“ : Datum des Hauptbeitrags
„1“ : Datum des aktuellsten Beitrags
tinyint3.5.9
FromMainPosting1 Ab dem „wievielten MainPosting“ soll die Rückgabemenge beginnen. Um z.B. die ersten 10 „MainPostings“ zu bekommen, übergibt man die Standard-Werte; für die nächsten 10, übergibt man „FromMainPosting = 11“ und „MaxNumberOfThreads = 10“ usw.
integer3.5.9
MaxNumberOfThreads10 Wieviele „MainPostings“ sollen in der Rückgabemenge sein. Um z.B. die ersten 10 „MainPostings“ zu bekommen, übergibt man die Standard-Werte; für die nächsten 10, übergibt man „FromMainPosting = 11“ und „MaxNumberOfThreads = 10“ usw.
tinyint3.5.9
IncludePostingBodies0 Gibt an, ob in der Rückgabemenge auch der „Body“ (d.h. der Beitrag selbst) des jeweiligen Postings ausgegeben werden soll
bit3.5.9
Visibility12 Nur Postings ausgeben, 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.
tinyint3.5.9
ShowPostDateOfMainPosting1 Hat nur im Fall „SortCriteria = 1“ Bedeutung. Und zwar gibt dieser Parameter an, ob das Datum des „MainPostings“ ausgegeben werden soll, oder das Datum des aktuellsten Beitrags im Thread.
bit3.5.11
GetOwnNotApprovedPostings0 Konnte eine Person identifiziert werden und wird hier „1“ übergeben, werden nicht nur „Visibility“ entsprechende Beiträge berücksichtigt, sondern auch eigene (d.h. Autor ist die identif. Person), unbestätigte Beiträge (dazu ist lesend. Zugr. erforderl.)
bit4.0.5
OutputIntoOneID0 „0“ : Nur eine Ergebnismenge liefern
„1“ : Anstelle einer Ergebnismenge werden die „PostingID“s in „tempdb.dbo.OneID“ eingefügt
„2“ : Es wird sowohl eine Ergebnismenge geliefert als auch die „PostingID“s in „tempdb.dbo.OneID“ eingefügt
tinyint4.0.16
SortingCriteriaNoNULL Nummer eines zuvor durch fo_ModifyMainPostSortCrit_Ad definierten Kriteriums, nach dem die Hauptbeiträge des Forums „ForumID“ sortiert sind und entsprechend ausgegeben werden sollen. Bei „NULL“ bestimmt „SortCriteria“ die Sorierung.
tinyint5.0.4
ReverseOrderOfSorting0 Wie sortiert wird :
- „0“ : „SortingCriteriaNo“ entspr. bzw. absteigend nach dem durch „SortCriteria“ bestimmten Thread-Datum
- „1“ : umgekehrte Reihenfolge von „SortingCriteriaNo“ bzw. aufsteigend nach dem durch „SortCriteria“ bestimmten Thread-Datum
bit5.0.4
SeparatorInIdentVals'¶' Gibt an, durch welche Zeichenkette die Werte in „PersonIdentificationValues“ getrennt sind
varchar(4)5.5.0

Rückgabe

wenn OutputIntoOneID IN (0,2)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
PostDateSortNo5)Wurde bis 5.0.4 zur Sortierung verwendet. Ab dieser Version jedoch kann die Sortierung (s. Parameter „SortingCriteriaNo“) nicht mehr anhand einer „einfachen“ Tabellen-Spalte beschrieben werden !
integer3.5.9
PostingIDID eines MainPostings
integer3.5.9
VisibleSichtbarkeits-Status des Postings „PostingID“ - mögliche Werte : siehe fo_GetPostingVisibilities
tinyint3.5.9
PostDateNICHT MEHR VERWENDEN ! Datum des Beitrags „PostingID“ (Format : „15.03.2001 20:48:13“). Im Fall „SortCriteria = 1“ und „ShowPostDateOfMainPosting = 0“ wird hier jedoch das Datum des aktuellsten Beitrags im gesamten „PostingID-Thread“ ausgegeben.
varchar(19)3.5.9
MainPostingPostDateEnthält das Datum des Hauptbeitrags „PostingID“, und zwar im Format „15.03.2001 20:48:13“
varchar(19)5.0.4
LatestPostingPostDateEnthält das Datum des aktuellsten Beitrags (dessen „Visible“-Status „Visibility“ entspricht) im gesamten „Thread“ des Hauptbeitrags „PostingID“, und zwar im Format „15.03.2001 20:48:13“
varchar(19)5.0.4
AuthorName des Verfassers des Beitrags „PostingID“
varchar(100)3.5.9
AuthorPersonID(Person)ID des Verfassers „Author“ - „0“ bedeutet, daß der Verfasser anonym ist
integer3.5.9
EMailOfAuthoreMail des Verfassers „Author“
varchar(100)3.5.9
SubjectDer Titel des Beitrags „PostingID“
varchar(255)3.5.9
BodyDer Beitrag selbst - immer „NULL“ falls „IncludePostingBodies = 0“ oder wenn „SmallBody“ NICHT „NULL“ ist
text3.5.9
HasBinariesSind „Binaries“ zu dem Posting „PostingID“ vorhanden ?
bit3.5.9
AlreadyReadWurde das Posting vor „HoursAfterPostingsAreRegardedAsRead“ (Eintrag in „ForumSettings“) Stunden verfaßt ODER gibt es zur Person, die diese Prozedur aufruft, einen Eintrag in „ReadPostingsPerPerson“, steht hier der Wert „1“
bit3.5.9
PostingsInThreadWieviele Antworten hat „PostingID“ (inkl. Antworten auf Antworten usw.). Dabei zählen nur Beiträge, die einen „Visibility“ entsprechenden „Sichtbarkeits-Status“ haben bzw. (falls „GetOwnNotApprovedPosting = 1“) deren Autor die identifizierte Person ist!
integer3.5.9
NewPostingsInThreadWieviele (für die identif. Person) „neue“ (s. „AlreadyRead“) Postings gibt es im Thread. Es zählen nur Beiträge, die einen „Visibility“ entspr. „Sichtbarkeits-Status“ haben bzw. (falls „GetOwnNotApprovedPosting = 1“) deren Autor die identif. Person ist!
integer3.5.9
SmallBodyHier erscheint der Beitrag selbst, falls er weniger als 256 Zeichen enthält UND „UseSmallBody“ in „ForumSettings“ auf „1“ gesetzt UND „IncludePostingBodies = 1“ ist. D.h. mindestens EINE der Rückgabespalten „SmallBody“ und „Body“ ist IMMER „NULL“.
varchar(255)3.5.17
PostingIDOfLatestPostingID des aktuellsten Beitrags (dessen „Visible“-Status „Visibility“ entspricht) im gesamten „Thread“ des Hauptbeitrags „PostingID“
integer5.1.1

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 6)
-850Sortier-Kriterium nicht definiert oder inaktiv oder nicht verwendbarnur direkt
-805Keine Berechtigung zum Löschen von Postingsnur direkt
-802Keine Berechtigung zum Bestätigen von Postings des Forumsnur direkt
-801Kein lesender Zugriff auf das Forumnur direkt
-660Identifikation fehlgeschlagennur indirekt
-621Fehlender oder falscher Eintrag in PersonTypeSettingsnur indirekt
-602Zur defaultUniqueID („VisitorID = -2“) können keinerlei Daten gespeichert oder verändert werdennur indirekt
-599Lizenz ist ungültig oder abgelaufennur indirekt
-569Der Benutzer hat kein Ausführungsrecht für die Prozedurnur indirekt
-567Die Prozedur darf z. Zt. nicht ausgeführt werdennur indirekt
-566Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werdennur indirekt
-550Fehlender oder falscher Eintrag in Settingsnur indirekt
-535Das Datum liegt nicht in der Vergangenheitnur indirekt
-530Der Wert ist nicht konvertierbarnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-504Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochennur indirekt
-502Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)nur indirekt
-500Falsche Parameterdirekt 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„Start-/Finish-Procedure“-Logik eingebaut, s. Ticket #3670
7.0.1 2013-08-07Sortierungsumkehr auch bei „SortingCriteriaNo = NULL“
6.5.3 2013-03-18Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
6.5.0 2012-09-17Holger Wies : Wird in „UniqueID“ die „DefaultUniqueID“ angegeben, wird nun [ohne Aufruf von
pm_CheckPersonIdentity_Pu] der Aufrufer als „anonyme Person“ [„PersonID = 0“] identifiziert
6.0.2 2011-06-08Interner workaround für das Problem, daß der Parameter „ForumID“ als „integer“ deklariert wurde - es muß nämlich
ein „smallint“ sein !
6.0.0 2010-03-26Fehler falls eine „SortingCriteriaNo“ angegeben und ein „FromMainPosting“-Wert übergeben wurde, der größer war
als die gesamte Anzahl „MainPostings“ : Es wurde immer das [der Sortierung nach] LETZTE „MainPosting“ zurückgegeben
5.5.0 2008-01-071. Neuer Parameter „SeparatorInIdentVals“
2. Ausgabe an die Standard-Ausgabe [via „print“] im Fehler-Fall „-500“, die nähere Informationen über die Ursache enthält
5.1.5 2006-08-29Fehler in der „blättern“-Funktionalität bei gegebener „SortingCriteriaNo“
5.1.1 2006-04-05Neue Rückgabespalte „PostingIDOfLatestPosting“
5.1.0 2006-02-08Ab jetzt wird explizit auf „lesendes Recht“ [„AccessLevelID = 1“] geprüft
5.0.4 2005-09-261. Neue Rückgabespalten „MainPostingPostDate“ und „LatestPostingPostDate“
2. Neue Parameter „SortingCriteriaNo“ und „ReverseOrderOfSorting“
3. Interne Änderungen zur Verbesserung der Performance
4. Ab jetzt gibt es „-500“, wenn „FromMainPosting < 1“
4.0.16 2004-08-311. Neuer Parameter „OutputIntoOneID“
2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
3. Konsequente Fehlerbehandlung
4.0.5 2003-10-04Neuer Parameter „GetOwnNotApprovedPostings“
4.0.3 2003-07-101. Fehler bzgl. Initialisierung von internen Variablen anhand von „Settings“-Einträgen
2. Parameter-Check für „Visibility“ geändert („Visibility = 0“ gibt jetzt auch „-500“)
4.0.1 2003-05-16Fehler bzgl. der „Visible“-Status-Überprüfung [„Visibility“ entsprechend], falls man AUCH gelöschte Beiträge sehen möchte [aber nicht nur !], also falls „Visibility & 1 = 1“ UND „Visibility > 1“
4.0.0 2003-04-03Fehler bzgl. der „Visible“-Status-Überprüfung [„Visibility“ entsprechend] im Fall „SortCriteria = 1“
3.5.21 2002-08-06
3.5.18 2002-05-15
3.5.17 2002-05-02
3.5.16 2002-04-25
3.5.14 2002-01-23
3.5.11 2001-09-06
3.5.10 2001-07-14
3.5.9 2001-06-16Erstmalig 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_GetMainPostings_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<value>&ForumID=<value>'

Mit xmllint 7) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/fo_GetMainPostings_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_GetMainPostings_Pu',
		array(
			'PersonIdentificationValues' => '<value>',
			'PersonTypeID' => <value>,
			'UniqueID' => '<value>',
			'ForumID' => <value>,
			// 'SortCriteria' => 0,
			// 'FromMainPosting' => 1,
			// 'MaxNumberOfThreads' => 10,
			// 'IncludePostingBodies' => 0,
			// 'Visibility' => 12,
			// 'ShowPostDateOfMainPosting' => 1,
			// 'GetOwnNotApprovedPostings' => 0,
			// 'OutputIntoOneID' => 0,
			// 'SortingCriteriaNo' => NULL,
			// 'ReverseOrderOfSorting' => 0,
			// '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_GetMainPostings_Pu">
			<Parameters>
				<Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter>
				<Parameter Name="PersonTypeID"><!-- tinyint value --></Parameter>
				<Parameter Name="UniqueID"><!-- varchar value --></Parameter>
				<Parameter Name="ForumID"><!-- integer value --></Parameter>
				<!-- <Parameter Name="SortCriteria">0</Parameter> -->
				<!-- <Parameter Name="FromMainPosting">1</Parameter> -->
				<!-- <Parameter Name="MaxNumberOfThreads">10</Parameter> -->
				<!-- <Parameter Name="IncludePostingBodies">0</Parameter> -->
				<!-- <Parameter Name="Visibility">12</Parameter> -->
				<!-- <Parameter Name="ShowPostDateOfMainPosting">1</Parameter> -->
				<!-- <Parameter Name="GetOwnNotApprovedPostings">0</Parameter> -->
				<!-- <Parameter Name="OutputIntoOneID">0</Parameter> -->
				<!-- <Parameter Name="SortingCriteriaNo">NULL</Parameter> -->
				<!-- <Parameter Name="ReverseOrderOfSorting">0</Parameter> -->
				<!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.
6)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
7)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/fo_getmainpostings_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)