Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:fo_getforumsettings_ad

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:fo_getforumsettings_ad [11.01.2016 ]
engine:procedures:fo_getforumsettings_ad [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== fo_GetForumSettings_Ad =====
 +
 +Gibt für Foren die gespeicherten Einstellungen ("​Settings"​) zurück.\\ ​
 +|HTTP-Method|GET |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[fo Get Forum Settings Ad]}}|
 +|Engine-Kategorie|forums |
 +|Engine-Typ|Daten-Ermittlung |
 +|Letzte Aktualisierung|7.0.7 (2015-01-29)|
 +
 +==== Parameter ====
 +
 +^Name ((Pflichtparameter sind unterstrichen)) ^Standard-Wert ^Beschreibung ((siehe [[webservice:​engine_parameterconventions|Parameter-Konventionen engine/<​Prozedur-Name>​]])) ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|__ForumID__| |ID eines Forums, zu dem man sich die "​Settings"​ anzeigen lassen möchte. Bei Angabe von "​NULL"​ erwartet die Prozedur "​ForumID"​s in "​tempdb.dbo.OneID"​.\\ |smallint|3.5.0|
 +|KeyVariable|NULL |Falls angegeben, werden nur die Einträge des Forums "​ForumID"​ (bzw. der in "​tempdb.dbo.OneID"​ angegebenen Foren) zu diesem Schlüssel berücksichtigt\\ |varchar(50)|4.0.0|
 +|Value|NULL |Falls angegeben, werden nur die Einträge zum Forum "​ForumID"​ (bzw. zu den "​tempdb.dbo.OneID"​ angegebenen Foren) ausgegeben, zu denen dieser Wert hinterlegt ist\\ |varchar(100)|4.0.0|
 +|PersonID|NULL |Falls angegeben, werden die Datensätze auf die Person, die durch diese ID identifiziert wird, eingeschränkt\\ |integer|4.0.6|
 +==== Rückgabe ====
 +
 +=== (parameterunabhängig) ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|ForumID|ID des Forums "​ForumID"​ - diese Rückgabespalte gibt es, da es in einer späteren dStore-Version möglich sein wird, sich "​Settings"​ für mehrere Foren anzeigen zu lassen\\ |smallint|3.5.0 |
 +|PersonID|ID einer Person, für die der Wert "​Value"​ zum Schlüssel "​KeyVariable"​ gilt. Steht hier eine "​0",​ handelt es sich um eine globale Einstellung für alle Teilnehmer, die nur durch einen weiteren Eintrag zur entsprechenden "​PersonID"​ überschrieben werden kann.\\ |integer|3.5.0 |
 +|KeyVariable|Ein Schlüssel, der zu einem Forum hinterlegt werden kann, wie z.B. "​KeepPostingsInDays"​\\ |varchar(50)|3.5.0 |
 +|Value|Der Wert, der für "​PersonID"​ zum Schlüssel "​KeyVariable"​ hinterlegt ist\\ |varchar(100)|3.5.0 |
 +
 +== Sortierung der Rückgabe ==
 +
 +(parameterunabängige Sortierung)
 +  * ForumID (aufsteigend)
 +  * PersonID (aufsteigend)
 +  * KeyVariable (aufsteigend)
 +
 +==== Output-Parameter ====
 +
 +Die Prozedur hat keine Output-Parameter.==== Mögliche Return-Codes ====
 +
 +^Code ^Beschreibung ^Quelle ((direkt meint "von der Prozedur selber"​ und indirekt meint "von intern aufgerufenen Unterprozeduren"​)) ^
 +|-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|
 +|-502|Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)|nur indirekt|
 +|-500|Falsche Parameter|direkt und indirekt|
 +==== XML-Schema ====
 +
 +Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema [[http://​resources.dstore.de/​xsd/​webservice_SmartGate/​Response/​EngineProcedure_v1_0.xsd|Response/​EngineProcedure_v1_0.xsd]] validiert.
 +==== Historie ====
 +
 +|7.0.7 |2015-01-29|Interne Änderung : Datentyp-Erweiterung des "​ReferenceKey"​ [für "​_mi_StartProcedure"​-Aufruf]\\ ​ |
 +|6.5.4 |2013-04-29|Anpassungen an aktuellen Code-Standard\\ ​ |
 +|6.5.3 |2013-03-18|Anpassungen an aktuellen Code-Standard,​ u.a. wg. UTF8-Unterstützung\\ ​ |
 +|4.0.10 |2004-03-15|1. Aufruf der Prozeduren "​_mi_StartProcedure",​ "​_mi_FinishProcedure"​ und "​_mi_ChooseParamValueSeperator"​\\ 2. "set transaction isolation level 1", "set rowcount 0" zu Beginn d. Prozedur\\ 3. Performance-Verbesserung in einigen Fällen\\ ​ |
 +|4.0.6 |2003-11-14|Neuer Parameter "​PersonID"​\\ ​ |
 +|4.0.0 |2003-04-03|1. Man kann jetzt auch mehrere "​ForumID"​s über "​tempdb.dbo.OneID"​ übergeben\\ 2. Sortierung nach "​ForumID",​ "​PersonID"​ und "​KeyVariable"​\\ 3. Neue Paramter "​KeyVariable"​ und "​Value"​\\ ​ |
 +|3.5.0 |2000-11-23|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:
 +  * [[http://​playground.dstore.de/​index.php?​proc=fo_GetForumSettings_Ad|fo_GetForumSettings_Ad im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​fo_GetForumSettings_Ad?​ForumID=<​value>'</​code>​Mit xmllint ((I.d.R. auf Unix-artigen Systemen bereits installiert,​ Bestandteil der libxml2, siehe http://​www.xmlsoft.org)) formatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​fo_GetForumSettings_Ad?​ForumID=<​value>'​ | xmllint --format -</​code>​== dStore_php ==
 +<code 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_GetForumSettings_Ad',​
 + array(
 + '​ForumID'​ => <​value>,​
 + // '​KeyVariable'​ => NULL,
 + // '​Value'​ => NULL,
 + // '​PersonID'​ => NULL
 + )
 +);
 +
 +$service->​execute($request);​
 +
 + $xml_result = $request->​getResponse()->​getBody()->​toSimpleXmlDocument();​
 + $ResultSet = $xml_result->​getRowsAsArray();​
 +
 +</​code>​
 +== engine/​execute ==
 +XML zur Ausführung mit der Methode [[:​webservice:​engine:​execute|engine/​execute]],​ z.B. per
 +  curl --header '​Content-Type:​ application/​xml'​ -X POST '​http://<​partner>​-<​kunde>​.dstore.de/​default/​engine/​execute'​ -d '<​xml-daten>'​
 +
 +<code xml>
 +<?xml version="​1.0"​ encoding="​UTF-8"?>​
 +<​ListOfBatches>​
 + <Batch No="​0">​
 + <​Procedure Name="​fo_GetForumSettings_Ad">​
 + <​Parameters>​
 + <​Parameter Name="​ForumID"><​!-- smallint value --></​Parameter>​
 + <!-- <​Parameter Name="​KeyVariable">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​Value">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​PersonID">​NULL</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/fo_getforumsettings_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)