Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:fo_getforumcategories_ad

fo_GetForumCategories_Ad

Gibt Kategorien zurück, in die Foren eingeordnet werden können.

HTTP-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategoriebasics
Engine-TypDaten-Ermittlung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
PredecessorForumCategoryIDNULL ID einer Forum-Kategorie. Falls angegeben, werden nur die Kategorien ausgegeben, die dieser Kategorie untergeordnet sind, ansonsten werden alle „Hauptkategorien“ (das sind Kategorien, die keine übergeordnete Kategorie besitzen) ermittelt.
smallint4.0.4

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
ForumCategoryIDID einer Forum-Kategorie
smallint4.0.4
CategoryDescriptionBezeichnung der Kategorie „ForumCategoryID“
varchar(100)4.0.4
SortNoBestimmt die Reihenfolge von „ForumCategoryID“ innerhalb aller Kategorien, die „PredecessorForumCategoryID“ untergeordnet sind - falls dieser Parameter mit „NULL“ angegeben wurde, „ForumCategoryID“ also eine „Hauptkategorie“ ist, steht hier immer „0“
tinyint4.0.4
ContainsCategoriesOrForumsGibt an, ob „ForumCategoryID“ Foren und/oder Kategorien zugeordnet sind.
„0“ : Enthält weder Unterkategorien noch Foren
„1“ : Enthält nur Unterkategorien
„2“ : Enthält nur Foren
„3“ : Enthält sowohl Foren als auch Unterkategorien
tinyint4.0.4
Sortierungen der Rückgabe

wenn PredecessorForumCategoryID is NULL

  • ForumCategoryID (aufsteigend)

wenn PredecessorForumCategoryID is NOT NULL

  • SortNo (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 5)
-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 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-29Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
5.5.0 2008-01-07In „ContainsCategoriesOrForums“ wurde entgegen der Doku ein „integer“ zurückgegeben
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. Fehlende Doku wie die Rückgabemenge sortiert wird
4.0.4 2003-08-26Erstmalig 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_GetForumCategories_Ad'

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/fo_GetForumCategories_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_GetForumCategories_Ad',
		array(
			// 'PredecessorForumCategoryID' => 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_GetForumCategories_Ad">
			<Parameters>
				<!-- <Parameter Name="PredecessorForumCategoryID">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
6)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/fo_getforumcategories_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)