Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:fo_getforums_pu

fo_GetForums_Pu

Gibt für eine Person eine Liste der Foren aus, auf die sie (mindestens) lesenden Zugriff besitzt. Falls die Identifizierung fehlschlägt oder in „UniqueID“ der Wert „defaultUniqueID“ angegeben wird, werden die Foren ausgegeben, auf die die anonyme Person („PersonID = 0“) Zugriff hat.

Hinweis : Es werden (seit Version 4.0.4) maximal 255 Datensätze zurückgegeben !

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.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.
tinyint3.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
ForumIDNULL ID eines Forums. Wird „NULL“ angegeben, gibt die Prozedur alle Foren zurück, auf die die identifizierte Person (mindestens) lesenden Zugriff hat (bzw. alle Foren für die als Sprache „LanguageID“ definiert ist).
smallint3.5.0
LanguageIDNULL ID einer Sprache. Optionale Filterung der Foren nach einer Sprache, in der die Beiträge verfaßt sind (oder verfaßt sein sollten…).
tinyint3.5.0
ForumCategoryIDListNULL Liste (durch '¶' getrennt) von „ForumCategoryID“s (Forum-Kategorien). Falls angegeben, werden nur Foren berücksichtigt, die wenigstens einer der hier angegebenen Kategorien zugeordnet sind
varchar(255)4.0.4
GetCategoryInformation0 „1“ angeben, um in der Rückgabemenge zusätzliche Informationen bzgl. Forum-Kategorien zu erhalten
bit4.0.4
SeparatorInIdentVals'¶' Gibt an, durch welche Zeichen die Werte in „PersonIdentificationValues“ getrennt sind
varchar(4)5.5.0

Rückgabe

wenn GetCategoryInformation = 0

Spaltenname Beschreibung SQL-Datentyp4) ab Version
ForumIDID eines vorhandenen Forums (bzw. gleich der „ForumID“), auf das die identifizierte Person (mindestens) lesenden Zugriff hat
smallint3.5.0
ForumNameName des Forums „ForumID“
varchar(100)3.5.0
LanguageIDID einer Sprache, die für das Forum „ForumID“ hinterlegt ist. Sie gibt an, in welcher Sprache die Beiträge dieses Forums verfaßt sind (bzw. verfaßt sein sollten…).
tinyint3.5.0
LanguageBezeichnung der Sprache „LanguageID“
varchar(50)3.5.0
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • ForumID (aufsteigend)

wenn GetCategoryInformation = 1

Spaltenname Beschreibung SQL-Datentyp5) ab Version
ForumIDID eines vorhandenen Forums (bzw. gleich der „ForumID“), auf das die identifizierte Person (mindestens) lesenden Zugriff hat
smallint4.0.4
ForumNameName des Forums „ForumID“
varchar(100)4.0.4
LanguageIDID einer Sprache, die für das Forum „ForumID“ hinterlegt ist. Sie gibt an, in welcher Sprache die Beiträge dieses Forums verfaßt sind (bzw. verfaßt sein sollten…).
tinyint4.0.4
LanguageBezeichnung der Sprache „LanguageID“
varchar(50)4.0.4
ForumCategoryIDID einer Forum-Kategorie, der „ForumID“ zugeordnet ist. Wurde „ForumCategoryIDList“ angegeben, steht hier „NULL“ oder eine übergebene ID. (Hinweis : Ein Forum kann theoretisch in mehreren Kategorien sein !)
smallint4.0.4
SortNoBestimmt die Reihenfolge von „ForumID“ innerhalb aller Foren, die „ForumCategoryID“ zugeordnet sind
tinyint4.0.4
CategoryDescriptionBezeichnung der Kategorie „ForumCategoryID“
varchar(100)4.0.4
PredecessorCategoryIDID einer Forum-Kategorie, die „ForumCategoryID“ übergeordnet ist. Es kann hier der gleiche Wert wie „ForumCategoryID“ stehen, dann handelt es sich um eine sogenannte „Hauptkategorie“ (der keine Kategorie übergeordnet ist).
smallint4.0.4
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • PredecessorCategoryID (aufsteigend)
  • SortNo (aufsteigend)
  • ForumID (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 6)
-801Kein lesender Zugriff auf das Forumnur direkt
-800Kein Zugriff auf das Forumnur indirekt
-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 Parameternur 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-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
5.5.0 2008-01-071. Neuer Parameter „SeparatorInIdentVals“
2. Bearbeitung des Quellcodes hinsichtlich neuer Konventionen
5.1.4 2006-08-141. Konsequente Fehlerbehandlung
2. Explizites „ORDER BY“ eingefügt, um die Sortierung der Rückgabemenge zu garantieren
4.0.13 2004-05-18Interner Fehler, falls „ForumCategoryIDList“ angegeben wurde ⇒ es gab immer ein leeres Ergebnis
4.0.4 2003-08-261. Diverse interne Änderungen
2. Neue Parameter „ForumCategoryIDList“ und „GetCategoryInformation“
4.0.0 2003-04-03Falls eine „ForumID“ angegeben wurde, war die Rückgabespalte für die „ForumID“ nicht benannt !
3.5.22 2002-08-30
3.5.21 2002-08-06
3.5.19 2002-06-17
3.5.0 2000-11-23Erstmalig 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_GetForums_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<value>'

Mit xmllint 7) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/fo_GetForums_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<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_GetForums_Pu',
		array(
			'PersonIdentificationValues' => '<value>',
			'PersonTypeID' => <value>,
			'UniqueID' => '<value>',
			// 'ForumID' => NULL,
			// 'LanguageID' => NULL,
			// 'ForumCategoryIDList' => NULL,
			// 'GetCategoryInformation' => 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_GetForums_Pu">
			<Parameters>
				<Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter>
				<Parameter Name="PersonTypeID"><!-- tinyint value --></Parameter>
				<Parameter Name="UniqueID"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="ForumID">NULL</Parameter> -->
				<!-- <Parameter Name="LanguageID">NULL</Parameter> -->
				<!-- <Parameter Name="ForumCategoryIDList">NULL</Parameter> -->
				<!-- <Parameter Name="GetCategoryInformation">0</Parameter> -->
				<!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
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_getforums_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)