Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- engine:procedures:fo_getmainpostings_pu [11.01.2016 ]
+++ engine:procedures:fo_getmainpostings_pu [11.01.2016 ] (aktuell)
@@ Zeile 1: / Zeile 1: @@
+===== fo_GetMainPostings_Pu =====
+Gibt zu einem Forum eine Liste von sogenannten "MainPostings" (oder auch "Threads") aus. Ein "MainPosting" ist sozusagen der START-Beitrag einer Kette von Postings ("Thread"), der sich also dadurch auszeichnet, daß er KEINE Antwort auf einen anderen Beitrag darstellt (intern gekennzeichnet durch die Eigenschaft "PostingID = MainPostingID").\\
+Die identifizierte Person muß natürlich über die entsprechenden Rechte für das Forum verfügen. Falls die Identifizierung fehlschlägt oder in "UniqueID" der Wert "defaultUniqueID" angegeben wird, werden die Rechte für die anonyme Person (mit der speziellen "PersonID = 0") gecheckt.\\
+Anmerkungen zum Parameter "Visibility" :\\ 1. Sofern auch gelöschte Beiträge berücksichtigt werden sollen, muß die identifizierte Person für das Forum mindestens eines der folgenden Rechte besitzen :\\ "16" : "löschen eigener Postings, sofern keine Replies vorhanden"\\ "32" : "löschen eigener Postings (inkl. Replies)"\\ "128" : "löschen aller Postings des Forums, sofern keine Replies vorhanden"\\ "256" : "löschen aller Postings des Forums (inkl. Replies)"\\ Besitzt die Person nur das Recht "16" oder "32" werden zudem nur die EIGENEN (Author entspricht der identifizierten Person) gelöschten Beiträge ausgegeben !\\ 2. Sollen nicht bestätigte Beiträge berücksichtigt werden, benötigt die identifizierte Person das Recht\\ "64" : "bestätigen von Postings des Forums"\\ für das Forum.\\
+Anmerkung zur Rückgabespalte "AlreadyRead" :\\ In "ForumSettings" gibt es einen Eintrag "HoursAfterPostingsAreRegardedAsRead", der angibt, ab wann ein Posting IMMER als gelesen gilt (einfach weil es in einem gewissen Sinn "alt" ist). Falls "MaintainReadPostingsPerPerson" für das angegebene Forum (in "ForumSettings") auf "1" steht, wird von jeder Prozedur, die Postings inkl. "Body" ausgibt, in der Tabelle "ReadPostingsPerPerson" festgehalten, welche Person welches Posting schon gelesen hat.\\ => Wurde das Posting vor "HoursAfterPostingsAreRegardedAsRead" Stunden verfaßt ODER gibt es zur Person, die diese Prozedur aufruft, einen Eintrag in "ReadPostingsPerPerson", ist "AlreadyRead = 1".\\
+Anmerkung zu den Rückgabespalten "PostingsInThread" und "NewPostingsInThread" :\\ Es werden nur die Antworten berücksichtigt (also nicht das "MainPosting" selbst) !\\
+|HTTP-Method|GET |
+|HTTP-Auth|Optional |
+|Tags|{{tag>[fo Get Main Postings 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)|3.5.9|
+|__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|3.5.9|
+|__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)|3.5.9|
+|__ForumID__| |ID eines Forums. Hinweis : Datentyp muß eigentlich ein "smallint" sein. Aufgrund der Abwärtskompatibilität bleibt dies zwar so, aber es gibt "-500", falls Werte außerhalb des Wertebereichs "-32768 bis 32767" übergeben werden.\\ |integer|3.5.9|
+|SortCriteria|0 |Wird nur beachtet, wenn "SortingCriteriaNo" NICHT "NULL" ! Es wird nach dem "Thread-Datum" sortiert (auf-/absteigend, s. "ReverseOrderOfSorting"). Hiermit definiert man "Thread-Datum" :\\ "0" : Datum des Hauptbeitrags\\ "1" : Datum des aktuellsten Beitrags\\ |tinyint|3.5.9|
+|FromMainPosting|1 |Ab dem "wievielten MainPosting" soll die Rückgabemenge beginnen. Um z.B. die ersten 10 "MainPostings" zu bekommen, übergibt man die Standard-Werte; für die nächsten 10, übergibt man "FromMainPosting = 11" und "MaxNumberOfThreads = 10" usw.\\ |integer|3.5.9|
+|MaxNumberOfThreads|10 |Wieviele "MainPostings" sollen in der Rückgabemenge sein. Um z.B. die ersten 10 "MainPostings" zu bekommen, übergibt man die Standard-Werte; für die nächsten 10, übergibt man "FromMainPosting = 11" und "MaxNumberOfThreads = 10" usw.\\ |tinyint|3.5.9|
+|IncludePostingBodies|0 |Gibt an, ob in der Rückgabemenge auch der "Body" (d.h. der Beitrag selbst) des jeweiligen Postings ausgegeben werden soll\\ |bit|3.5.9|
+|Visibility|12 |Nur Postings ausgeben, die einen bestimmten "Sichtbarkeitsstatus" ("Visible" in "ForumPostings") haben; für eine Filterung nach mehreren "Visible"-Status gibt man einfach die entsprechende Summe an. Mögliche Werte : siehe [[dstoreproc>fo_GetPostingVisibilities]].\\ |tinyint|3.5.9|
+|ShowPostDateOfMainPosting|1 |Hat nur im Fall "SortCriteria = 1" Bedeutung. Und zwar gibt dieser Parameter an, ob das Datum des "MainPostings" ausgegeben werden soll, oder das Datum des aktuellsten Beitrags im Thread.\\ |bit|3.5.11|
+|GetOwnNotApprovedPostings|0 |Konnte eine Person identifiziert werden und wird hier "1" übergeben, werden nicht nur "Visibility" entsprechende Beiträge berücksichtigt, sondern auch eigene (d.h. Autor ist die identif. Person), unbestätigte Beiträge (dazu ist lesend. Zugr. erforderl.)\\ |bit|4.0.5|
+|OutputIntoOneID|0 |"0" : Nur eine Ergebnismenge liefern\\ "1" : Anstelle einer Ergebnismenge werden die "PostingID"s in "tempdb.dbo.OneID" eingefügt\\ "2" : Es wird sowohl eine Ergebnismenge geliefert als auch die "PostingID"s in "tempdb.dbo.OneID" eingefügt\\ |tinyint|4.0.16|
+|SortingCriteriaNo|NULL |Nummer eines zuvor durch [[dstoreproc>fo_ModifyMainPostSortCrit_Ad]] definierten Kriteriums, nach dem die Hauptbeiträge des Forums "ForumID" sortiert sind und entsprechend ausgegeben werden sollen. Bei "NULL" bestimmt "SortCriteria" die Sorierung.\\ |tinyint|5.0.4|
+|ReverseOrderOfSorting|0 |Wie sortiert wird :\\ - "0" : "SortingCriteriaNo" entspr. bzw. absteigend nach dem durch "SortCriteria" bestimmten Thread-Datum\\ - "1" : umgekehrte Reihenfolge von "SortingCriteriaNo" bzw. aufsteigend nach dem durch "SortCriteria" bestimmten Thread-Datum\\ |bit|5.0.4|
+|SeparatorInIdentVals|'¶' |Gibt an, durch welche Zeichenkette die Werte in "PersonIdentificationValues" getrennt sind\\ |varchar(4)|5.5.0|
+==== Rückgabe ====
+=== wenn OutputIntoOneID IN (0,2) ===
+^Spaltenname  ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^
+|//PostDateSortNo((Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.))//|Wurde bis 5.0.4 zur Sortierung verwendet. Ab dieser Version jedoch kann die Sortierung (s. Parameter "SortingCriteriaNo") nicht mehr anhand einer "einfachen" Tabellen-Spalte beschrieben werden !\\ |integer|3.5.9 |
+|PostingID|ID eines MainPostings\\ |integer|3.5.9 |
+|Visible|Sichtbarkeits-Status des Postings "PostingID" - mögliche Werte : siehe [[dstoreproc>fo_GetPostingVisibilities]]\\ |tinyint|3.5.9 |
+|PostDate|NICHT MEHR VERWENDEN ! Datum des Beitrags "PostingID" (Format : "15.03.2001 20:48:13"). Im Fall "SortCriteria = 1" und "ShowPostDateOfMainPosting = 0" wird hier jedoch das Datum des aktuellsten Beitrags im gesamten "PostingID-Thread" ausgegeben.\\ |varchar(19)|3.5.9 |
+|MainPostingPostDate|Enthält das Datum des Hauptbeitrags "PostingID", und zwar im Format "15.03.2001 20:48:13"\\ |varchar(19)|5.0.4 |
+|LatestPostingPostDate|Enthält das Datum des aktuellsten Beitrags (dessen "Visible"-Status "Visibility" entspricht) im gesamten "Thread" des Hauptbeitrags "PostingID", und zwar im Format "15.03.2001 20:48:13"\\ |varchar(19)|5.0.4 |
+|Author|Name des Verfassers des Beitrags "PostingID"\\ |varchar(100)|3.5.9 |
+|AuthorPersonID|(Person)ID des Verfassers "Author" - "0" bedeutet, daß der Verfasser anonym ist\\ |integer|3.5.9 |
+|EMailOfAuthor|eMail des Verfassers "Author"\\ |varchar(100)|3.5.9 |
+|Subject|Der Titel des Beitrags "PostingID"\\ |varchar(255)|3.5.9 |
+|Body|Der Beitrag selbst - immer "NULL" falls "IncludePostingBodies = 0" oder wenn "SmallBody" NICHT "NULL" ist\\ |text|3.5.9 |
+|HasBinaries|Sind "Binaries" zu dem Posting "PostingID" vorhanden ?\\ |bit|3.5.9 |
+|AlreadyRead|Wurde das Posting vor "HoursAfterPostingsAreRegardedAsRead" (Eintrag in "ForumSettings") Stunden verfaßt ODER gibt es zur Person, die diese Prozedur aufruft, einen Eintrag in "ReadPostingsPerPerson", steht hier der Wert "1"\\ |bit|3.5.9 |
+|PostingsInThread|Wieviele Antworten hat "PostingID" (inkl. Antworten auf Antworten usw.). Dabei zählen nur Beiträge, die einen "Visibility" entsprechenden "Sichtbarkeits-Status" haben bzw. (falls "GetOwnNotApprovedPosting = 1") deren Autor die identifizierte Person ist!\\ |integer|3.5.9 |
+|NewPostingsInThread|Wieviele (für die identif. Person) "neue" (s. "AlreadyRead") Postings gibt es im Thread. Es zählen nur Beiträge, die einen "Visibility" entspr. "Sichtbarkeits-Status" haben bzw. (falls "GetOwnNotApprovedPosting = 1") deren Autor die identif. Person ist!\\ |integer|3.5.9 |
+|SmallBody|Hier erscheint der Beitrag selbst, falls er weniger als 256 Zeichen enthält UND "UseSmallBody" in "ForumSettings" auf "1" gesetzt UND "IncludePostingBodies = 1" ist. D.h. mindestens EINE der Rückgabespalten "SmallBody" und "Body" ist IMMER "NULL".\\ |varchar(255)|3.5.17 |
+|PostingIDOfLatestPosting|ID des aktuellsten Beitrags (dessen "Visible"-Status "Visibility" entspricht) im gesamten "Thread" des Hauptbeitrags "PostingID"\\ |integer|5.1.1 |
+==== 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")) ^
+|-850|Sortier-Kriterium nicht definiert oder inaktiv oder nicht verwendbar|nur direkt|
+|-805|Keine Berechtigung zum Löschen von Postings|nur direkt|
+|-802|Keine Berechtigung zum Bestätigen von Postings des Forums|nur direkt|
+|-801|Kein lesender Zugriff auf das Forum|nur direkt|
+|-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\\  |
+|7.0.1 |2013-08-07|Sortierungsumkehr auch bei "SortingCriteriaNo = NULL"\\  |
+|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\\  |
+|6.0.2 |2011-06-08|Interner workaround für das Problem, daß der Parameter "ForumID" als "integer" deklariert wurde - es muß nämlich\\ ein "smallint" sein !\\  |
+|6.0.0 |2010-03-26|Fehler falls eine "SortingCriteriaNo" angegeben und ein "FromMainPosting"-Wert übergeben wurde, der größer war\\ als die gesamte Anzahl "MainPostings" : Es wurde immer das [der Sortierung nach] LETZTE "MainPosting" zurückgegeben\\  |
+|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.5 |2006-08-29|Fehler in der "blättern"-Funktionalität bei gegebener "SortingCriteriaNo"\\  |
+|5.1.1 |2006-04-05|Neue Rückgabespalte "PostingIDOfLatestPosting"\\  |
+|5.1.0 |2006-02-08|Ab jetzt wird explizit auf "lesendes Recht" ["AccessLevelID = 1"] geprüft\\  |
+|5.0.4 |2005-09-26|1. Neue Rückgabespalten "MainPostingPostDate" und "LatestPostingPostDate"\\ 2. Neue Parameter "SortingCriteriaNo" und "ReverseOrderOfSorting"\\ 3. Interne Änderungen zur Verbesserung der Performance\\ 4. Ab jetzt gibt es "-500", wenn "FromMainPosting < 1"\\  |
+|4.0.16 |2004-08-31|1. Neuer Parameter "OutputIntoOneID"\\ 2. Ausführen von "set transaction isolation level 1" und "set rowcount 0" zu Beginn der Prozedur\\ 3. Konsequente Fehlerbehandlung\\  |
+|4.0.5 |2003-10-04|Neuer Parameter "GetOwnNotApprovedPostings"\\  |
+|4.0.3 |2003-07-10|1. Fehler bzgl. Initialisierung von internen Variablen anhand von "Settings"-Einträgen\\ 2. Parameter-Check für "Visibility" geändert ("Visibility = 0" gibt jetzt auch "-500")\\  |
+|4.0.1 |2003-05-16|Fehler bzgl. der "Visible"-Status-Überprüfung ["Visibility" entsprechend], falls man AUCH gelöschte Beiträge sehen möchte [aber nicht nur !], also falls "Visibility & 1 = 1" UND "Visibility > 1"\\  |
+|4.0.0 |2003-04-03|Fehler bzgl. der "Visible"-Status-Überprüfung ["Visibility" entsprechend] im Fall "SortCriteria = 1"\\  |
+|3.5.21 |2002-08-06|\\  |
+|3.5.18 |2002-05-15|\\  |
+|3.5.17 |2002-05-02|\\  |
+|3.5.16 |2002-04-25|\\  |
+|3.5.14 |2002-01-23|\\  |
+|3.5.11 |2001-09-06|\\  |
+|3.5.10 |2001-07-14|\\  |
+|3.5.9 |2001-06-16|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_GetMainPostings_Pu|fo_GetMainPostings_Pu im Engine Playground öffnen]]
+== cURL ==
+Unformatierte Ausgabe:
+<code bash>
+curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/fo_GetMainPostings_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<value>&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_GetMainPostings_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<value>&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_GetMainPostings_Pu',
+		array(
+			'PersonIdentificationValues' => '<value>',
+			'PersonTypeID' => <value>,
+			'UniqueID' => '<value>',
+			'ForumID' => <value>,
+			// 'SortCriteria' => 0,
+			// 'FromMainPosting' => 1,
+			// 'MaxNumberOfThreads' => 10,
+			// 'IncludePostingBodies' => 0,
+			// 'Visibility' => 12,
+			// 'ShowPostDateOfMainPosting' => 1,
+			// 'GetOwnNotApprovedPostings' => 0,
+			// 'OutputIntoOneID' => 0,
+			// 'SortingCriteriaNo' => NULL,
+			// 'ReverseOrderOfSorting' => 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_GetMainPostings_Pu">
+			<Parameters>
+				<Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter>
+				<Parameter Name="PersonTypeID"><!-- tinyint value --></Parameter>
+				<Parameter Name="UniqueID"><!-- varchar value --></Parameter>
+				<Parameter Name="ForumID"><!-- integer value --></Parameter>
+				<!-- <Parameter Name="SortCriteria">0</Parameter> -->
+				<!-- <Parameter Name="FromMainPosting">1</Parameter> -->
+				<!-- <Parameter Name="MaxNumberOfThreads">10</Parameter> -->
+				<!-- <Parameter Name="IncludePostingBodies">0</Parameter> -->
+				<!-- <Parameter Name="Visibility">12</Parameter> -->
+				<!-- <Parameter Name="ShowPostDateOfMainPosting">1</Parameter> -->
+				<!-- <Parameter Name="GetOwnNotApprovedPostings">0</Parameter> -->
+				<!-- <Parameter Name="OutputIntoOneID">0</Parameter> -->
+				<!-- <Parameter Name="SortingCriteriaNo">NULL</Parameter> -->
+				<!-- <Parameter Name="ReverseOrderOfSorting">0</Parameter> -->
+				<!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> -->
+			</Parameters>
+		</Procedure>
+	</Batch>
+</ListOfBatches></code>

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Unterschiede

Seiten-Werkzeuge