Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
— |
engine:procedures:fo_modifyforums_ad [11.01.2016 ] (aktuell) |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
+ | ===== fo_ModifyForums_Ad ===== | ||
+ | |||
+ | Prozedur zur Verwaltung von Foren.\\ | ||
+ | |||
+ | Beim Anlegen eines Forums werden folgende Einträge in "ForumSettings" angelegt (immer "KeyVariable" : "Value"):\\ | ||
+ | |||
+ | "ApprovedPostingsOnly" : "0"\\ "MaximumBinarySizeInKB" : "0"\\ "MaxNumberOfBinariesPerPosting" : "0"\\ "MaintainReadPostings" : "0"\\ "HoursAfterPostingsAreRegardedAsRead" : "24"\\ "MaintainReadPostingsPerPerson" : "0"\\ "UseSmallBody" : "1"\\ "PostingDeletionOptions" : "1"\\ | ||
+ | |||
+ | Hinweis : Ein Forum kann nur gelöscht werden, wenn KEINE Beiträge vorhanden sind bzw. wenn alle Beiträge des Forums sich im "Visible"-Status "0" ("gelöscht") befinden !\\ | ||
+ | |HTTP-Method|POST | | ||
+ | |HTTP-Auth|Optional | | ||
+ | |Tags|{{tag>[fo Modify Forums Ad]}}| | ||
+ | |Engine-Kategorie|configurations | | ||
+ | |Engine-Typ|Daten-Änderung | | ||
+ | |Letzte Aktualisierung|7.0.7 (2015-01-29)| | ||
+ | |||
+ | ==== Parameter ==== | ||
+ | |||
+ | |__LanguageID__| |ID einer Sprache, in der die Beiträge des (neuen) Forums verfaßt sind (bzw. sein sollen)\\ |tinyint|3.5.0| | ||
+ | |__ForumName__| |Name des (neuen) Forums\\ |varchar(100)|3.5.0| | ||
+ | |DeleteForum|0 |Ist eine "ForumID" angegeben, entscheidet dieser Parameter, ob das vorhandene Forum geändert oder gelöscht werden soll\\ |bit|3.5.0| | ||
+ | ==== Rückgabe ==== | ||
+ | |||
+ | Die Prozedur hat keine Rückgaben. | ||
+ | ==== Output-Parameter ==== | ||
+ | |||
+ | |ForumID|ID eines Forums, für das Änderungen vorgenommen werden sollen bzw. das gelöscht werden soll (je nach "DeleteForum") - "NULL" angeben, um ein neues Forum anzulegen| | ||
+ | ==== Mögliche Return-Codes ==== | ||
+ | |||
+ | ^Code ^Beschreibung ^Quelle ((direkt meint "von der Prozedur selber" und indirekt meint "von intern aufgerufenen Unterprozeduren")) ^ | ||
+ | |-820|Das Forum kann nicht gelöscht werden, da noch Beiträge vorhanden sind|nur direkt| | ||
+ | |-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|nur 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\\ | | ||
+ | |6.5.0 |2012-09-17|1. Der Parameter "ForumID" ist jetzt ein Ausgabeparameter\\ 2. Kleine Performance-Verbesserung\\ | | ||
+ | |5.1.10 |2007-03-12|1. Den "ForumSettings"-Eintrag "AllowTags" gibt es nicht mehr (für solche Einträge ist "ApplicationSettings" zu verwenden)\\ 2. Neue "ForumSettings"-Einträge, die beim Anlegen standardmäßig gemacht werden ["UseSmallBody" und "PostingDeletionOptions"]\\ | | ||
+ | |5.1.2 |2006-06-26|Fehler im Löschen-Fall : 1. Wenn nur noch "Postings" mit dem "Visible"-Status "0" vorhanden waren, kam es entgegen der Doku zu einem [trigger-]Fehler\\ 2. Die Tabellen bzgl. Sortierung von "MainPostings" wurden nicht geleert\\ | | ||
+ | |4.0.10 |2004-03-15|1. Aufruf der Prozeduren "_mi_StartProcedure", "_mi_FinishProcedure" und "_mi_ChooseParamValueSeperator" als Vorbereitung von "_mi_StartProcedure"\\ 2. Ausführen von "set transaction isolation level 1" und "set rowcount 0" zu Beginn der Prozedur\\ | | ||
+ | |4.0.4 |2003-08-26|Ab jetzt kann ein Forum auch dann gelöscht werden wenn zwar Beiträge vorhanden sind, aber diese alle einen "Visible"-Status "0" ("gelöscht") haben !\\ | | ||
+ | |3.5.4 |2001-03-11|\\ | | ||
+ | |3.5.2 |2001-01-28|\\ | | ||
+ | |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_ModifyForums_Ad|fo_ModifyForums_Ad im Engine Playground öffnen]] | ||
+ | == cURL == | ||
+ | Unformatierte Ausgabe: | ||
+ | <code bash> | ||
+ | curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/fo_ModifyForums_Ad?LanguageID=<value>&ForumName=<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 POST 'http://<partner>-<project>.dstore.de/default/engine/fo_ModifyForums_Ad?LanguageID=<value>&ForumName=<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_ModifyForums_Ad', | ||
+ | array( | ||
+ | 'LanguageID' => <value>, | ||
+ | 'ForumName' => '<value>', | ||
+ | // 'DeleteForum' => 0 | ||
+ | ) | ||
+ | ); | ||
+ | |||
+ | $service->execute($request); | ||
+ | |||
+ | $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); | ||
+ | $ResultSet = $xml_result->getRowsAsArray(); | ||
+ | |||
+ | $OutputParams = $xml_result->getOutputParametersAsArray();</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_ModifyForums_Ad"> | ||
+ | <Parameters> | ||
+ | <Parameter Name="LanguageID"><!-- tinyint value --></Parameter> | ||
+ | <Parameter Name="ForumName"><!-- varchar value --></Parameter> | ||
+ | <!-- <Parameter Name="DeleteForum">0</Parameter> --> | ||
+ | </Parameters> | ||
+ | </Procedure> | ||
+ | </Batch> | ||
+ | </ListOfBatches></code> | ||