fo_GetPostingReplies_Pu [dstore]

Inhaltsverzeichnis

fo_GetPostingReplies_Pu

fo_GetPostingReplies_Pu

Liefert die Antworten zu einem Forum-Beitrag in einer „flat“-Struktur, d.h. im Gegensatz zu fo_GetPostingThread_Pu werden alle Antworten (auch Antworten auf Antworten etc.) ermittelt und nach dem „PostDate“ (dem Anlagedatum des Beitrags also) sortiert ausgegeben.

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“.

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

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	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)	5.1.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	5.1.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)	5.1.0
PostingID		ID eines Beitrags, zu dem die Antworten ermittelt werden sollen	integer	5.1.0
IncludePostingID	0	Gibt an, ob man „PostingID“ selbst auch im Ergebnis haben möchte („1“) oder nicht („0“)	bit	5.1.0
OnlyRepliesUpToLevel	0	„0“ angeben, um ALLE Antworten auf „PostingID“ berücksichtigen zu lassen. Sollen nur DIREKTE Antworten ermittelt werden, ist hier „1“ anzugeben. Bei einem Wert von „2“ würden direkte Antworten auf die direkten Antworten berücksichtigt usw.	tinyint	5.1.0
OrderDesc	1	Die Antworten werden nach dem „PostDate“ (dem Anlagedatum) sortiert ausgegeben - dieser Parameter entscheidet, ob eine AUFsteigende („0“) oder ABsteigende („1“) Sortierung verwendet wird	bit	5.1.0
FromRowNumber	1	Hiermit kann man sich (zusammen mit „MaxNumberOfPostings“) durch das gesamte Ergebnis „blättern“. Die Ausgabe beginnt mit der Antort, die in der intern ermittelten Menge aller Antworten (sortiert nach dem „PostDate“) an dieser Stelle/Position kommt.	integer	5.1.0
MaxNumberOfPostings	20	In jedem Fall werden immer nur soviele Antworten zurückgegeben, wir durch diesen Parameter angegeben ist („NULL“ oder „0“ ist NICHT erlaubt !)	tinyint	5.1.0
Visibility	12	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.	tinyint	5.1.0
GetOwnNotApprovedPostings	0	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.)	bit	5.1.0
IncludePostingBodies	0	Gibt an, ob in der Rückgabemenge auch der „Body“ (d.h. der Beitrag selbst) des jeweiligen Postings ausgegeben werden soll	bit	5.1.0
OutputIntoOneID	0	„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	tinyint	5.1.0
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-Datentyp⁴⁾	ab Version
PostingID	ID eines Beitrags, der eine (direkte oder indirekte) Antwort auf „PostingID“ darstellt	integer	5.1.0
ReplyToPostingID	ID des Postings, auf das „PostingID“ eine Antwort darstellt. Falls gleich „PostingID“, handelt es sich um einen Haupt-Beitrag, sprich „MainPosting“	integer	5.1.0
PostDate	Datum des Beitrags „PostingID“	datetime	5.1.0
PostDate_char	„PostDate“ als String im Format : „15.03.2001 20:48:13:545“	varchar(23)	5.1.0
AuthorPersonID	(Person)ID des Verfassers „Author“ - „0“ bedeutet, daß der Verfasser anonym ist	integer	5.1.0
Author	Name des Verfassers des Beitrags „PostingID“	varchar(100)	5.1.0
EMailOfAuthor	eMail des Verfassers „Author“	varchar(100)	5.1.0
Subject	Der Titel des Beitrags „PostingID“	varchar(255)	5.1.0
Body	Der Beitrag selbst - „NULL“ falls „SmallBody“ NICHT „NULL“ ist	text	5.1.0
SmallBody	Hier 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)	5.1.0
Visible	Sichtbarkeits-Status des Postings „PostingID“ - mögliche Werte : siehe fo_GetPostingVisibilities	tinyint	5.1.0
HasBinaries	Sind „Binaries“ zu dem Posting „PostingID“ vorhanden ?	bit	5.1.0
AlreadyRead	Wurde 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“	bit	5.1.0

Sortierungen der Rückgabe

wenn OrderDesc = 0

PostDate (aufsteigend)

wenn OrderDesc = 1

PostDate (absteigend)

Output-Parameter

NumberOfReplies	Wieviele Antworten es insgesamt auf „PostingID“ gibt, kann man über diesen Ausgabeparameter erfahren - hierbei wird „PostingID“ selbst jedoch NICHT mitgezählt (selbst wenn „IncludePostingID = 1“ ist) !
MainPostingID	Ausgabeparameter, der den zur „PostingID“ zugehörigen Hauptbeitrag enthält

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-805	Keine Berechtigung zum Löschen von Postings	nur direkt
-802	Keine Berechtigung zum Bestätigen von Postings des Forums	nur direkt
-801	Kein lesender 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	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	„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. Ausgabe an die Standard-Ausgabe [via „print“] im Fehler-Fall “-500“, die nähere Informationen über die Ursache enthält
5.1.0	2006-02-08	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_GetPostingReplies_Pu im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/fo_GetPostingReplies_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<value>&PostingID=<value>'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/fo_GetPostingReplies_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<value>&PostingID=<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_GetPostingReplies_Pu',
		array(
			'PersonIdentificationValues' => '<value>',
			'PersonTypeID' => <value>,
			'UniqueID' => '<value>',
			'PostingID' => <value>,
			// 'IncludePostingID' => 0,
			// 'OnlyRepliesUpToLevel' => 0,
			// 'OrderDesc' => 1,
			// 'FromRowNumber' => 1,
			// 'MaxNumberOfPostings' => 20,
			// 'Visibility' => 12,
			// 'GetOwnNotApprovedPostings' => 0,
			// 'IncludePostingBodies' => 0,
			// 'OutputIntoOneID' => 0,
			// 'SeparatorInIdentVals' => '¶'
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();
 
$OutputParams = $xml_result->getOutputParametersAsArray();

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_GetPostingReplies_Pu">
			<Parameters>
				<Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter>
				<Parameter Name="PersonTypeID"><!-- tinyint value --></Parameter>
				<Parameter Name="UniqueID"><!-- varchar value --></Parameter>
				<Parameter Name="PostingID"><!-- integer value --></Parameter>
				<!-- <Parameter Name="IncludePostingID">0</Parameter> -->
				<!-- <Parameter Name="OnlyRepliesUpToLevel">0</Parameter> -->
				<!-- <Parameter Name="OrderDesc">1</Parameter> -->
				<!-- <Parameter Name="FromRowNumber">1</Parameter> -->
				<!-- <Parameter Name="MaxNumberOfPostings">20</Parameter> -->
				<!-- <Parameter Name="Visibility">12</Parameter> -->
				<!-- <Parameter Name="GetOwnNotApprovedPostings">0</Parameter> -->
				<!-- <Parameter Name="IncludePostingBodies">0</Parameter> -->
				<!-- <Parameter Name="OutputIntoOneID">0</Parameter> -->
				<!-- <Parameter Name="SeparatorInIdentVals">'¶'</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