Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- engine:procedures:fo_getforumcategories_pu [11.01.2016 ]
+++ engine:procedures:fo_getforumcategories_pu [11.01.2016 ] (aktuell)
@@ Zeile 1: / Zeile 1: @@
+===== fo_GetForumCategories_Pu =====
+Gibt alle Forum-Kategorien zurück, die einer bestimmten Kategorie (-> "ForumCategoryID") untergeordnet sind.\\
+Es werden nur die Kategorien berücksichtigt, die mindestens ein Forum enthalten (direkt oder indirekt, d.h. in einer Unter-Unter-...-Kategorie), auf das die identifizierte Person lesenden Zugriff besitzt; außerdem werden die Kategorien berücksichtigt, denen weder eine Kategorie untergeordnet noch ein Forum zugeordnet ist.\\ Anmerkung : Falls die Identifizierung fehlschlägt oder in "UniqueID" der Wert "defaultUniqueID" angegeben wird, werden die Rechte für die anonyme Person ("PersonID = 0") herangezogen.\\
+Hinweise :\\ 1. Möchte man (aus Performance-Gründen) einfach alle Kategorien unterhalb von "ForumCategoryID" ausgegeben bekommen, ohne daß auf lesenden Zugriff geprüft wird, ist der Parameter "DoNotCheckAccessRights" auf "1" zu setzen. In diesem Fall wird auch keine Identifizierung durchgeführt.\\ 2. Der erste Datensatz der Ergebnismenge enthält immer die Kategorie "ForumCategoryID" selbst - mit "0" als "SortNo".\\
+Anmerkungen zur Rückgabespalte "ContainsCategoriesOrForums" :\\ 1. Der Wert "3" bedeutet, daß die Kategorie sowohl Foren als auch Unterkategorien enthält. Ob die identifizierte Person auf wenigstens ein Forum, das der Kategorie direkt zugeordnet ist, lesenden Zugriff hat, geht allerdings nicht daraus hervor (d.h. es kann sein, daß die Person z.B. nur auf ein Forum, das einer der Unterkategorien zugeordnet ist, Zugriff hat) !\\ 2. Der Wert "4" kann nur im Fall "DoNotCheckAccessRights = 0" auftreten.\\
+|HTTP-Method|GET |
+|HTTP-Auth|Optional |
+|Tags|{{tag>[fo Get Forum Categories Pu]}}|
+|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 ^
+|__PersonIdentificationValues__| |Liste von Werten, die den Forum-Teilnehmer identifizieren. Diese Werte müssen Eigenschaften zu den Merkmal-IDs sein, die in "PersonTypeSettings" zur "PersonTypeID" zum Schlüssel "PersonIdentificationIDs" hinterlegt sind.\\ |varchar(255)|4.0.4|
+|__PersonTypeID__| |ID des Personen-Typs dem der zu identifizierende Forum-Teilnehmer angehört. Dieser muß bei einer Identifizierung immer mit angegeben werden, da die Merkmale zur Identifizierung pro Personentyp variieren können.\\ |tinyint|4.0.4|
+|__UniqueID__| |Eindeutige ID eines Besuchers, die dem zu identifizierenden Forum-Teilnehmer aktuell zugeordnet ist. Falls die Identifizierungsdaten zur Person in "SessionManagement" (zur "UniqueID") gespeichert sind, darf "PersonIdentificationValues" "NULL" sein.\\ |varchar(50)|4.0.4|
+|__ForumCategoryID__| |ID einer Forum-Kategorie, zu der die untergeordneten Kategorien ermittelt werden sollen\\ |smallint|4.0.4|
+|DoNotCheckAccessRights|0 |"0" : Identifizierung durchgeführen. Nur die Kategorien werden ausgegeben, die mindestens ein Forum enthalten, auf das die identifizierte Person lesenden Zugriff hat.\\ "1" : Keine Identifizierung durchführen. Alle untegeordneten Kategorien ausgeben.\\ |bit|4.0.4|
+|SeparatorInIdentVals|'¶' |Gibt an, durch welche Zeichen die Werte in "PersonIdentificationValues" getrennt sind\\ |varchar(4)|5.5.0|
+==== Rückgabe ====
+=== (parameterunabhängig) ===
+^Spaltenname  ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^
+|ForumCategoryID|ID einer Forum-Kategorie, die "ForumCategoryID" untergeordnet ist (oder "ForumCategoryID" selbst)\\ |smallint|4.0.4 |
+|CategoryDescription|Bezeichnung der Kategorie "ForumCategoryID"\\ |varchar(100)|4.0.4 |
+|SortNo|Bestimmt die Reihenfolge von "ForumCategoryID" innerhalb aller Kategorien, die "ForumCategoryID" untergeordnet sind ("0" für "ForumCategoryID" selbst)\\ |tinyint|4.0.4 |
+|ContainsCategoriesOrForums|Gibt an, was "ForumCategoryID" enthält :\\ "0" : Weder Unterkategorien noch Foren\\ "1" : Nur Unterkategorien\\ "2" : Nur Foren\\ "3" : Sowohl Foren als auch Unterkategorien\\ "4" : Nur Unterkategorien, die wiederum auch keine Foren enthalten\\ (s.Beschreibung)\\ |tinyint|4.0.4 |
+== Sortierung der Rückgabe ==
+(parameterunabängige Sortierung)
+  * SortNo (aufsteigend)
+  * ForumCategoryID (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")) ^
+|-660|Identifikation fehlgeschlagen|nur indirekt|
+|-621|Fehlender oder falscher Eintrag in PersonTypeSettings|nur indirekt|
+|-602|Zur defaultUniqueID ("VisitorID = -2") können keinerlei Daten gespeichert oder verändert werden|nur indirekt|
+|-599|Lizenz ist ungültig oder abgelaufen|nur indirekt|
+|-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|
+|-550|Fehlender oder falscher Eintrag in Settings|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|"Start-/Finish-Procedure"-Logik eingebaut, s. Ticket #3670\\  |
+|6.5.3 |2013-03-18|Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung\\  |
+|6.5.0 |2012-09-17|Holger Wies : Wird in "UniqueID" die "DefaultUniqueID" angegeben, wird nun [ohne Aufruf von\\ [[dstoreproc>pm_CheckPersonIdentity_Pu]]] der Aufrufer als "anonyme Person" ["PersonID = 0"] identifiziert\\  |
+|5.5.0 |2008-01-07|1. Neuer Parameter "SeparatorInIdentVals"\\ 2. Ausgabe an die Standard-Ausgabe [via "print"] im Fehler-Fall "-500", die nähere Informationen über die Ursache enthält\\  |
+|5.1.0 |2006-02-08|Fehler bei der Sortierung im Fall "DoNotCheckAccessRights = 1"\\  |
+|4.0.11 |2004-03-31|1. Behebung diverser Fehler\\ 2. Bug im ASE führte zu falscher Rückgabemenge in manchen Fällen\\ 3. Konsequente Fehlerbehandlung\\ 4. "set transaction isolation level 1" und "set rowcount 0" zu Beginn\\  |
+|4.0.4 |2003-08-26|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_GetForumCategories_Pu|fo_GetForumCategories_Pu im Engine Playground öffnen]]
+== cURL ==
+Unformatierte Ausgabe:
+<code bash>
+curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/fo_GetForumCategories_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<value>&ForumCategoryID=<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_GetForumCategories_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<value>&ForumCategoryID=<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_GetForumCategories_Pu',
+		array(
+			'PersonIdentificationValues' => '<value>',
+			'PersonTypeID' => <value>,
+			'UniqueID' => '<value>',
+			'ForumCategoryID' => <value>,
+			// 'DoNotCheckAccessRights' => 0,
+			// 'SeparatorInIdentVals' => '¶'
+		)
+);
+$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_GetForumCategories_Pu">
+			<Parameters>
+				<Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter>
+				<Parameter Name="PersonTypeID"><!-- tinyint value --></Parameter>
+				<Parameter Name="UniqueID"><!-- varchar value --></Parameter>
+				<Parameter Name="ForumCategoryID"><!-- smallint value --></Parameter>
+				<!-- <Parameter Name="DoNotCheckAccessRights">0</Parameter> -->
+				<!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> -->
+			</Parameters>
+		</Procedure>
+	</Batch>
+</ListOfBatches></code>

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Unterschiede

Seiten-Werkzeuge