fo_GetForumSettings_Pu [dstore]

Inhaltsverzeichnis

fo_GetForumSettings_Pu

fo_GetForumSettings_Pu

Liefert für ein Forum den zu einem Schlüssel (→ „KeyVariable“) hinterlegten Wert für einen Teilnehmer zurück. Falls der Teilnehmer nicht identifiziert werden kann oder wenn zum Schlüssel kein Wert für die identifizierte Person hinterlegt ist oder in „UniqueID“ der Wert „defaultUniqueID“ angegeben wird, wird der Wert für die anonyme Person („PersonID = 0“) herangezogen.

Seit dieser Version kann man sich auch ALLE „Settings“ eines Forums ausgeben lassen, indem man für „KeyVariable“ den Wert „NULL“ angibt.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[fo, Get, Forum, Settings, 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)	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, zu dem ein (oder die) „Settings“-Eintrag (-Einträge) ermittelt werden soll	smallint	3.5.0
KeyVariable		Ein Schlüssel, der für ein Forum hinterlegt werden kann und zu dem der für „ForumID“ hinterlegte Wert ermittelt werden soll. Wird „NULL“ angegeben, werden alle „Settings“-Einträge für das Forum ausgegeben	varchar(100)	3.5.0
SelectResult	0	Der Parameter wird nur berücksichtigt, wenn für „KeyVariable“ NICHT „NULL“ angegeben wurde ! „0“ : Den hinterlegten Wert nur über den Ausgabeparameter „Value“ zurückgeben „1“ : ZUSÄTZLICH eine Ergebnismenge ausgeben	bit	3.5.0
SeparatorInIdentVals	'¶'	Gibt an, durch welche Zeichen die Werte in „PersonIdentificationValues“ getrennt sind	varchar(4)	5.5.0

Rückgabe

wenn SelectResult = 1 und KeyVariable is NOT NULL

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
Value	Der zum Schlüssel „KeyVariable“ hinterlegte Wert im Forum „ForumID“ - zur identifizierten Person bzw. zur anonymen Person („PersonID = 0“)	varchar(100)	3.5.0

wenn KeyVariable is NULL

Spaltenname	Beschreibung	SQL-Datentyp⁵⁾	ab Version
KeyVariable	Ein Schlüssel, zu dem für das Forum „ForumID“ zur identifizierten Person bzw. zur anonymen Person („PersonID = 0“) ein Wert hinterlegt ist	varchar(50)	3.5.7
Value	Der zu „KeyVariable“ hinterlegt Wert	varchar(100)	3.5.7

Output-Parameter

Value

Ausgabeparameter für den zum Schlüssel „KeyVariable“ im Forum „ForumID“ hinterlegten Wert. Der Ausgabeparameter wird natürlich nicht belegt, wenn alle „Settings“-Einträge ermittelt werden sollen („KeyVariable = NULL“).

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁶⁾
-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 3. Kleine Performance-Verbesserung im Fall „KeyVariable is NULL“
3.5.7	2001-05-04
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:

fo_GetForumSettings_Pu im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁷⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/fo_GetForumSettings_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<value>&ForumID=<value>&KeyVariable=<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_GetForumSettings_Pu',
		array(
			'PersonIdentificationValues' => '<value>',
			'PersonTypeID' => <value>,
			'UniqueID' => '<value>',
			'ForumID' => <value>,
			'KeyVariable' => '<value>',
			// 'SelectResult' => 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_GetForumSettings_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="KeyVariable"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="SelectResult">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