Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

@@ Zeile 1: / Zeile 1: @@
+===== fo_GetPostingCharacs_Pu =====
+Gibt zu einem Forum alle Merkmale aus, zu denen Postings (dieses Forums) Eigenschaften besitzen können - sofern die identifizierte Person lesenden Zugriff auf das Forum des Beitrags hat.\\
+Anmerkung :\\ 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 !\\
+Grundsätzliches zu Posting-Eigenschaften :\\ 1. Eigenschaften eines Beitrags sind immer an eine "PersonID" gebunden. Dies bedeutet, daß eine Eigenschaft entweder "allgemein" gültigt ist - nämlich wenn "PersonID = 0" ist - oder die Eigenschaft hat nur Gültigkeit für die durch "PersonID" angegebene Person. Pro Merkmal ist durch das sogenannte "CommonCharacteristic"-Flag (s. Rückgabemenge) konfiguriert, ob
+  * nur
+  * auch
+  * keine
+allgemeine(n) Eigenschaften hinterlegt werden können.\\ 2. Genau wie im "Item-" und "Person-Management" gehören Eigenschaften immer zu einem Merkmal - Merkmale charakterisieren sozusagen die Eigenschaften.\\ Wenn für das zugehörige Forum eines Beitrags mindestens ein Merkmal zugeordnet ist (-> [[dstoreproc>fo_ModifyCharacsForForums_Ad]]), können diesem Beitrag ausschließlich Eigenschaften zu Merkmalen hinzugefügt werden, die dem Forum zugeordnet sind.\\ 3. Sind dem Forum eines Beitrags direkt KEINE Merkmale zugeordnet (-> [[dstoreproc>fo_ModifyCharacsForForums_Ad]]), können diesem Beitrag ausschließlich Eigenschaften zu Merkmalen hinzugefügt werden, die wenigestens einer Kategorie, in die das Forum DIREKT eingeordnet ist, zugeordnet sind (-> [[dstoreproc>fo_ModifyCharacForForumCats_Ad]]).\\
+|HTTP-Method|GET |
+|HTTP-Auth|Optional |
+|Alias|fo_GetPostingCharacteristics_Pu |
+|Tags|{{tag>[fo Get Posting Characteristics 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.16|
+|__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.16|
+|__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.16|
+|__ForumID__| |ID eines Forums, zu dem die zugeordneten Merkmale ermittelt werden sollen. Die identifizierte Person muß natürlich mindestens lesenden Zugriff haben. Schlägt die Identifizierung fehl, werden die Rechte der anonymen Person ("PersonID = 0") herangezogen.\\ |integer|4.0.16|
+|CharacteristicIDList|NULL |Liste von (durch "¶" getrennte) "PostingCharacteristicID"s. Falls nicht "NULL", enthält das Ergebnis nur die Merkmale, die dem Forum "ForumID" (direkt oder indirekt, s. Beschreibung) zugeordnet sind UND deren ID in dieser List vorkommt.\\ |varchar(250)|4.0.16|
+|SeparatorInIdentVals|'¶' |Gibt an, durch welche Zeichenkette 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 ^
+|PostingCharacteristicID|ID eines Posting-Merkmals\\ |smallint|4.0.16 |
+|CharacteristicDescription|Bezeichnung des Merkmals "PostingCharacteristicID"\\ |varchar(100)|4.0.16 |
+|FieldTypeID|ID eines "Feld-Typs", von dem alle Eigenschaften des Merkmals "PostingCharacteristicID" sein müssen (z.B. "Text mit maximal 20 Zeichen")\\ |tinyint|4.0.16 |
+|FieldTypeDescription|Bezeichnung des Feld-Typs "FieldTypeID", z.B. "Ganze Zahlen von -999 bis 999" oder "Text - 20 Zeichen"\\ |varchar(100)|4.0.16 |
+|BasicFieldTypeID|ID des Basis-Feld-Typs, der "FieldTypeID" zugrunde liegt (siehe auch [[dstoreproc>mi_GetFieldTypes_Ad]])\\ |tinyint|4.0.16 |
+|BasicFieldType|Bezeichnung des Basis-Feld-Typs (z.B. "Zahl")\\ |varchar(20)|4.0.16 |
+|MaxLength|Maximale Anzahl Zeichen, die Eigenschaften zum Merkmal "PostingCharacteristicID" haben dürfen\\ |tinyint|4.0.16 |
+|PrecisionValue|Gilt nur für Datentypen mit Basis-Daten-Typ "Zahl" und gibt die Anzahl erlaubter Nachkommastellen an, die in Eigenschaften zum Merkmal "PostingCharacteristicID" vorkommen dürfen.\\ |tinyint|4.0.16 |
+|Format|Von welchem "Format" (so etwas wie ein regulären Ausdruck) müssen die Eigenschaften zum Merkmal "PostingCharacteristicID" sein. Derzeit nicht implementiert und verwendet !\\ |varchar(255)|4.0.16 |
+|PropertyModificationAllowed|Gibt an, ob Eigenschaften zum Merkmal nachträglich geändert werden können. Es ist eine Summe folgender Werte :\\ "0" : Hinzufügen, Ändern oder Löschen ist NICHT möglich\\ "1" : Hinzufügen ist möglich\\ "2" : Ändern ist möglich\\ "4" : Löschen ist möglich\\ |tinyint|4.0.16 |
+|CommonCharacteristic|Gibt an, zu welchen "PersonID"s Eigenschaften zum Merkmal hinterlegt werden können :\\ "0" : Nur "PersonID"s ungleich "0"\\ "1" : "PersonID" kann beliebig sein\\ "2" : Nur "PersonID = 0"\\ |tinyint|4.0.16 |
+|PredefinedValues|Sind mögliche Eigenschaften für Postings zum Merkmal vordefiniert ("1") oder nicht ("0")\\ |bit|4.0.16 |
+|CheckPostingVisibility|"1" bedeutet, daß das LESEN von Eigenschaften zum Merkmal (über [[dstoreproc>fo_GetPostingProperties_Pu]]) nur erlaubt ist, wenn die identifizierte Person auch den Beitrag lesen darf - was ja vom "Visible"-Status des jeweiligen Beitrags abhängt\\ |bit|4.0.16 |
+|MaxNumberOfProperties|Gibt an, wieviele Eigenschaften zum Merkmal ein Beitrag (bei gleicher "PersonID") maximal haben darf :\\ - "NULL" : Keine Einschränkung\\ - "0"    : Dieser Wert ist nicht erlaubt\\ - "1"    : Maximal 1 Eigenschaft\\ - "2"    : Maximal 2 Eigenschaften\\ usw.\\ |tinyint|4.0.16 |
+== Sortierung der Rückgabe ==
+(parameterunabängige Sortierung)
+  * CharacteristicDescription (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")) ^
+|-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\\  |
+|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\\ 3. Bearbeitung des Quellcodes hinsichtlich neuer Konventionen\\  |
+|5.1.0 |2006-02-08|Ab jetzt wird explizit auf "lesendes Recht" ["AccessLevelID = 1"] geprüft\\  |
+|4.0.16 |2004-08-31|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_GetPostingCharacs_Pu|fo_GetPostingCharacs_Pu im Engine Playground öffnen]]
+== cURL ==
+Unformatierte Ausgabe:
+<code bash>
+curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/fo_GetPostingCharacs_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_GetPostingCharacs_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_GetPostingCharacs_Pu',
+		array(
+			'PersonIdentificationValues' => '<value>',
+			'PersonTypeID' => <value>,
+			'UniqueID' => '<value>',
+			'ForumID' => <value>,
+			// 'CharacteristicIDList' => NULL,
+			// '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_GetPostingCharacs_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="CharacteristicIDList">NULL</Parameter> -->
+				<!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> -->
+			</Parameters>
+		</Procedure>
+	</Batch>
+</ListOfBatches></code>

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Unterschiede

Seiten-Werkzeuge