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-Method | GET |
HTTP-Auth | Optional |
Tags | |
Engine-Kategorie | forums |
Engine-Typ | Daten-Ermittlung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
ForumID | NULL | ID eines Forums. Wird „NULL“ angegeben, gibt die Prozedur alle Foren zurück bzw. alle Foren für die als Sprache „LanguageID“ definiert ist. | smallint | 3.5.0 |
LanguageID | NULL | ID einer Sprache. Optionale Filterung der Foren nach einer Sprache, in der die Beiträge verfaßt sind (oder verfaßt sein sollten…). | tinyint | 3.5.0 |
ForumCategoryID | NULL | 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). | smallint | 4.0.4 |
OnlyForumCategoriesInOneID | 0 | 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) | bit | 4.0.4 |
SortOrder | 0 | 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“ | tinyint | 4.0.4 |
GetCategoryInformation | 0 | „1“ angeben, um in der Rückgabemenge zusätzliche Informationen bzgl. Forum-Kategorien zu erhalten | bit | 4.0.4 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
ForumID | ID eines vorhandenen Forums (bzw. gleich der „ForumID“) | smallint | 3.5.0 |
ForumName | Name des Forums „ForumID“ | varchar(100) | 3.5.0 |
LanguageID | ID 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…). | tinyint | 3.5.0 |
Language | Bezeichnung der Sprache „LanguageID“ | varchar(50) | 3.5.0 |
wenn SortOrder = 0
wenn SortOrder = 1
wenn SortOrder = 2
Spaltenname | Beschreibung | SQL-Datentyp5) | ab Version |
---|---|---|---|
ForumID | ID eines vorhandenen Forums (bzw. gleich der „ForumID“) | smallint | 4.0.4 |
ForumName | Name des Forums „ForumID“ | varchar(100) | 4.0.4 |
LanguageID | ID 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…). | tinyint | 4.0.4 |
Language | Bezeichnung der Sprache „LanguageID“ | varchar(50) | 4.0.4 |
ForumCategoryID | ID 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 ! | smallint | 4.0.4 |
SortNo | Bestimmt die Reihenfolge von „ForumID“ innerhalb aller Foren, die „ForumCategoryID“ zugeordnet sind | tinyint | 4.0.4 |
CategoryDescription | Bezeichnung der Kategorie „ForumCategoryID“ | varchar(100) | 4.0.4 |
PredecessorCategoryID | ID 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). | smallint | 4.0.4 |
wenn SortOrder = 0
wenn SortOrder = 1
wenn SortOrder = 2
wenn SortOrder = 3
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 6) |
---|---|---|
-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 | direkt und 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.1.9 | 2007-01-26 | 1. 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-14 | Explizites „ORDER BY“ eingefügt, um die Sortierung der Rückgabemenge zu garantieren |
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. Konsequente Fehlerbehandlung |
4.0.4 | 2003-08-26 | Neue Parameter „ForumCategoryID“, „OnlyForumCategoriesInOneID“, „SortOrder“ und „GetCategoryInformation“ |
3.5.0 | 2000-11-23 | 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_GetForums_Ad'
Mit xmllint 7) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/fo_GetForums_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_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();
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>