Gibt Kategorien zurück, in die Foren eingeordnet werden können.
HTTP-Method | GET |
HTTP-Auth | Optional |
Tags | |
Engine-Kategorie | basics |
Engine-Typ | Daten-Ermittlung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
PredecessorForumCategoryID | NULL | 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. | smallint | 4.0.4 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
ForumCategoryID | ID einer Forum-Kategorie | smallint | 4.0.4 |
CategoryDescription | Bezeichnung der Kategorie „ForumCategoryID“ | varchar(100) | 4.0.4 |
SortNo | Bestimmt 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“ | tinyint | 4.0.4 |
ContainsCategoriesOrForums | Gibt 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 | tinyint | 4.0.4 |
wenn PredecessorForumCategoryID is NULL
wenn PredecessorForumCategoryID is NOT NULL
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 5) |
---|---|---|
-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 |
-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 |
-500 | Falsche Parameter | nur indirekt |
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
7.0.7 | 2015-01-29 | Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf] |
5.5.0 | 2008-01-07 | In „ContainsCategoriesOrForums“ wurde entgegen der Doku ein „integer“ zurückgegeben |
4.0.10 | 2004-03-15 | 1. 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-26 | Erstmalig in dieser Version erstellt |
Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
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 -
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();
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>