fo_GetPostingVisibilities [dstore]

Inhaltsverzeichnis

fo_GetPostingVisibilities

fo_GetPostingVisibilities

Gibt mögliche Sichtbarkeiten für Postings in den Foren zurück.

Anmerkungen:
Unter „Visible“ ist zunächst der interne „Sichtbarkeits-Status“ zu verstehen, d.h. die ID, die zu jedem Posting hinterlegt ist (Spalte „Visible“ in „ForumPostings“). Wenn man aber in diversen „Get“-Prozeduren (wie z.B. fo_GetPostingThread_Pu) nach diesem Status filtern möchte, tritt ein Problem auf : Eine Filterung erfolgt immer durch einen einzigen Parameter (meist „Visibility“), der die Summe der „Visible“-IDs, nach denen man das Ergebnis einschränken möchte, enthält. Müßte man den internen Status „Visible“ verwenden, könnte nie nach „gelöschten“ Postings gefiltert werden, da hierfür die ID „0“ verwendet wird. Aus diesem Grund ist eine Art „Mapping“ vom internen „Visible“-Status zum „Visible“-Status, der in „Get“-Prozeduren verwendet werden kann, notwendig ⇒ Rückgabespalte „Visible_Get“.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[fo, Get, Posting, Visibilities]
Engine-Kategorie	forums
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	3.5.18 (2002-05-15)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
Visible	NULL	Optionale Filterung nach einem internen Sichtbarkeits-Status	tinyint	3.5.18
Visible_Get	NULL	Optionale Filterung nach dem Sichtbarkeits-Status, der für diverse „Get“-Prozeduren (z.B. fo_GetPostingThread_Pu) benötigt wird. (Hintergrund : Der Status „gelöscht“ hat die interne ID „0“.)	tinyint	3.5.18

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
Visible	ID eines „Sichtbarkeits-Status“ für „Postings“ - abgebildet in der gleichnamigen Spalte der Tabelle „ForumPostings“	tinyint	3.5.18
Visibility	Bezeichnung für den Status „Visible“	varchar(50)	3.5.18
Description	Beschreibung des Status „Visible“	varchar(255)	3.5.18
Visible_Get	ID eines „Sichtbarkeits-Status“ für „Postings“, der für den Parameter „Visibility“ diverser „Get“-Prozeduren (z.B. fo_GetPostingThread_Pu) benötigt wird. (Hintergrund : Der Status „gelöscht“ hat die interne ID „0“.)	tinyint	3.5.18

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Die Prozedur hat keine Fehlercodes.

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

3.5.18

2002-05-15

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_GetPostingVisibilities im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/fo_GetPostingVisibilities'

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/fo_GetPostingVisibilities' | 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_GetPostingVisibilities',
		array(
			// 'Visible' => NULL,
			// 'Visible_Get' => NULL
		)
);
 
$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_GetPostingVisibilities">
			<Parameters>
				<!-- <Parameter Name="Visible">NULL</Parameter> -->
				<!-- <Parameter Name="Visible_Get">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Inhaltsverzeichnis