Benutzer-Werkzeuge

Webseiten-Werkzeuge

engine:procedures:fo_getforums_ad

Inhaltsverzeichnis

fo_GetForums_Ad

Prozedur, um einsehen zu können, welche Foren es gibt.

Hinweis zum Parameter „SortNo“ :
Der Wert „3“ kann nur angegeben werden, falls „GetCategoryInformation = 1“ übergeben wird !

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
ForumIDNULL ID eines Forums. Wird „NULL“ angegeben, gibt die Prozedur alle Foren zurück 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
ForumCategoryIDNULL ID einer Forum-Kategorie (wird nur beachtet, falls „OnlyForumCategoriesInOneID = 0“). Falls angegeben, werden nur die Foren, die dieser Kategorie zugeordnet sind, ausgegeben („ForumID“ und „LanguageID“ werden ignoriert).
smallint4.0.4
OnlyForumCategoriesInOneID0 Wird hierfür „1“ angegeben, ermittelt die Prozedur nur die Foren, die wenigstens einer der in „tempdb.dbo.OneID“ angegebenen Kategorien („ForumCategoryID“s) zugeordnet sind („ForumID“, „LanguageID“ und „ForumCategoryID“ werden ignoriert)
bit4.0.4
SortOrder0 Bestimmt die Sortierung der Rückgabemenge :
„0“ : aufsteigend nach „ForumID“
„1“ : aufsteigend nach „ForumName“, „ForumID“
„2“ : aufsteigend nach „Language“, „ForumName“, „ForumID“
„3“ : aufsteigend nach „PredecessorCategoryID“, „SortNo“ und „ForumID“
tinyint4.0.4
GetCategoryInformation0 „1“ angeben, um in der Rückgabemenge zusätzliche Informationen bzgl. Forum-Kategorien zu erhalten
bit4.0.4

Rückgabe

wenn GetCategoryInformation = 0

Spaltenname Beschreibung SQL-Datentyp4) ab Version
ForumIDID eines vorhandenen Forums (bzw. gleich der „ForumID“)
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
Sortierungen der Rückgabe

wenn SortOrder = 0

  • ForumID (aufsteigend)

wenn SortOrder = 1

  • ForumName (aufsteigend)
  • ForumID (aufsteigend)

wenn SortOrder = 2

  • Language (aufsteigend)
  • ForumName (aufsteigend)
  • ForumID (aufsteigend)

wenn GetCategoryInformation = 1

Spaltenname Beschreibung SQL-Datentyp5) ab Version
ForumIDID eines vorhandenen Forums (bzw. gleich der „ForumID“)
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 „ForumCategoryID“ oder „OnlyForumCategoriesInOneID = 1“ angegeben, steht hier natürlich eine der übergebenen IDs. 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
Sortierungen der Rückgabe

wenn SortOrder = 0

  • ForumID (aufsteigend)

wenn SortOrder = 1

  • ForumName (aufsteigend)
  • ForumID (aufsteigend)

wenn SortOrder = 2

  • Language (aufsteigend)
  • ForumName (aufsteigend)
  • ForumID (aufsteigend)

wenn SortOrder = 3

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

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 6)
-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
-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
-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-29Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
5.1.9 2007-01-261. Fehler in der Dokumentation der Rückgabespalte „ForumCategoryID“
2. Ausgabe an die Standard-Ausgabe [via „print“] im Fall „-500“, die nähere Informationen über die Ursache enthält
5.1.4 2006-08-14Explizites „ORDER BY“ eingefügt, um die Sortierung der Rückgabemenge zu garantieren
4.0.10 2004-03-151. Aufruf der Prozeduren „_mi_StartProcedure“ und „_mi_FinishProcedure“
2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
3. Konsequente Fehlerbehandlung
4.0.4 2003-08-26Neue Parameter „ForumCategoryID“, „OnlyForumCategoriesInOneID“, „SortOrder“ und „GetCategoryInformation“
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_Ad'

Mit xmllint 7) formatierte Ausgabe: 

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/fo_GetForums_Ad' | 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_Ad',
		array(
			// 'ForumID' => NULL,
			// 'LanguageID' => NULL,
			// 'ForumCategoryID' => NULL,
			// 'OnlyForumCategoriesInOneID' => 0,
			// 'SortOrder' => 0,
			// 'GetCategoryInformation' => 0
		)
);
 
$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_Ad">
			<Parameters>
				<!-- <Parameter Name="ForumID">NULL</Parameter> -->
				<!-- <Parameter Name="LanguageID">NULL</Parameter> -->
				<!-- <Parameter Name="ForumCategoryID">NULL</Parameter> -->
				<!-- <Parameter Name="OnlyForumCategoriesInOneID">0</Parameter> -->
				<!-- <Parameter Name="SortOrder">0</Parameter> -->
				<!-- <Parameter Name="GetCategoryInformation">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
2)
siehe Parameter-Konventionen engine/<Prozedur-Name>
3) , 4) , 5)
siehe Datentypen im Bereich "engine"
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_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)

Seiten-Werkzeuge