Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

@@ Zeile 1: / Zeile 1: @@
+===== co_GetMemberStatistics_Pu =====
+Gibt ein paar statistische Informationen zu einem Community-Mitglied zurück. Die gewünschten Informationen sind als Liste (durch "¶" getrennt) von folgenden IDs zu übergeben (-> "ListOfStatisticInformationIDs") :\\
+: "OnlineTime" (dazu muß "OnlineTimeDuringLastXMinutes" angegeben sein !) - der Wert in "Value" der Rückgabemenge ist eine Angabe in Sekunden\\ 2 : "NumberOfNewMessages"\\ 3 : "NumberOfAllMessages" (außer gelöschte Nachrichten !)\\ 4 : "NumberOfSentMessages" (außer gelöschte Nachrichten !)\\ 5 : "NumberOfPostingsInCommunityForums" (nur sichtbare "Postings" - d.h. "Visible = 4" !)\\ 6 : "MemberSince"\\ 7 : "LastLogout" (wenn "NULL", dann ist der User online)\\ 8 : "LastLogin"\\ 9 : "NumberOfPostingsInForum" (Anzahl der sichtbaren "Postings" im Forum "ForumID")\\
+Anmerkung zu "LastLogout"/"LastLogin" :\\ Da die Daten aus "UsersOnlineTime" im Regelfall durch den "Garbage-Collector" regelmäßig gelöscht werden, muß u.U. in "OnlineTimeStatistics" nachgeschaut werden, wann der Benutzer zuletzt in der Community war. Dort gibt es aber keine Uhrzeitangabe, so daß in diesem Fall KEINE Uhrzeit in der Rückgabemenge (im Format "hh:mi:ss") ist.\\
+|HTTP-Method|GET |
+|HTTP-Auth|Optional |
+|Tags|{{tag>[co Get Member Statistics Pu]}}|
+|Engine-Kategorie|communities |
+|Engine-Typ|Daten-Ermittlung |
+|Letzte Aktualisierung|6.5.4 (2013-04-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 ^
+|__UniqueID__| |Eindeutige ID eines Besuchers, die dem zu identifizierenden Mitglied aktuell zugeordnet ist. Falls die Identifizierungsdaten zur Person in "SessionManagement" (zu dieser "UniqueID") gespeichert sind, darf "PersonIdentificationValues" auch "NULL" sein.\\ |varchar(50)|3.5.2|
+|__PersonIdentificationValues__| |Liste von Werten, die das Mitglied identifizieren. Diese Werte müssen Eigenschaften zu den Merkmal-IDs sein, die in "PersonTypeSettings" zur "PersonTypeID" der "CommunityID" zum Schlüssel "PersonIdentificationIDs" hinterlegt sind.\\ |varchar(255)|3.5.2|
+|__CommunityID__| |ID einer Community\\ |smallint|3.5.2|
+|GetStatsForCommunityMemberID|NULL |ID eines Mitglieds der Communtiy "CommunityID", zu dem die Statistiken ermittelt werden sollen. Falls diese ID nicht übergeben wird, wählt die Prozedur die durch "UniqueID" und "PersonIdentificationValues" identifizierte Person aus.\\ |integer|3.5.2|
+|ListOfStatisticInformationIDs|NULL |Gibt an, welche Statistiken man bekommen möchte (ist nichts angegeben, werden alle zurückgegeben). Mögliche Werte : siehe Beschreibung\\ |varchar(100)|3.5.2|
+|OnlineTimeDuringLastXMinutes|NULL |Nur relevant, falls die "OnlineTime" ermittelt werden soll. Einen Wert größer "0" angeben, um die Online-Zeit des Mitglieds "GetStatsForCommunityMemberID" in den letzten "OnlineTimeDuringLastXMinutes" Minuten zu erhalten.\\ |integer|3.5.2|
+|DateFormat|'english' |Gibt an, wie die Werte in der Rückgabemenge formatiert werden sollen, wenn es Datumsangaben sind (Groß- und Kleinschreibung wird nicht beachtet) :\\ 'english' oder 'england' : "mm/dd/yyyy hh:mi:ss"\\ 'german' oder 'germany'  : "dd.mm.yyyy hh:mi:ss"\\ |varchar(10)|3.5.9|
+|ForumID|NULL |Nur relevant, falls "NumberOfPostingsInForum" zurückgegeben werden soll. Es wird dann die Anzahl Postings des Mitglieds "GetStatsForCommunityMemberID" im Forum "ForumID" ermittelt.\\ |smallint|3.5.14|
+|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 ^
+|StatisticInformationID|ID der Information (mögliche Werte : siehe Beschreibung)\\ |tinyint|3.5.2 |
+|StatisticInformation|Bezeichnung der Information (mögliche Werte : siehe Beschreibung)\\ |varchar(100)|3.5.2 |
+|Value|Der Wert zur Information "StatisticInformationID"\\ |varchar(100)|3.5.2 |
+==== 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")) ^
+|-781|Fehlender oder falscher Eintrag in CommunitySettings|nur indirekt|
+|-780|Fehlender oder falscher Eintrag in CommunityMemberSettings|nur indirekt|
+|-774|Login vorübergehend gesperrt|nur indirekt|
+|-773|Login gesperrt|nur indirekt|
+|-772|User ist nicht angemeldet|nur indirekt|
+|-771|Der Sweeper ist nicht gestartet|nur indirekt|
+|-770|Login zur Zeit nicht möglich|nur indirekt|
+|-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 ====
+|6.5.4 |2013-04-29|Datentyp des Parameters "SeparatorInIdentVals" wg. UTF-8 Unterstützung auf "varchar[4]" erweitert\\  |
+|5.5.0 |2008-01-07|1. Neuer Parameter "SeparatorInIdentVals"\\ 2. Ausgabe via "print" im Fehler-Fall "-500" (mit Informationen über die Ursache)\\ 3. Bearbeitung des Quellcodes hinsichtlich neuer Konventionen\\ 4. Fehler bzgl. der Ermittlung von "LastLogout"\\  |
+|3.5.20 |2002-07-22|\\  |
+|3.5.18 |2002-05-15|\\  |
+|3.5.17 |2002-05-02|\\  |
+|3.5.14 |2002-01-23|\\  |
+|3.5.12 |2001-10-17|\\  |
+|3.5.9 |2001-06-16|\\  |
+|3.5.7 |2001-05-04|\\  |
+|3.5.2 |2001-01-28|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=co_GetMemberStatistics_Pu|co_GetMemberStatistics_Pu im Engine Playground öffnen]]
+== cURL ==
+Unformatierte Ausgabe:
+<code bash>
+curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/co_GetMemberStatistics_Pu?UniqueID=<value>&PersonIdentificationValues=<value>&CommunityID=<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/co_GetMemberStatistics_Pu?UniqueID=<value>&PersonIdentificationValues=<value>&CommunityID=<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'),
+	'co_GetMemberStatistics_Pu',
+		array(
+			'UniqueID' => '<value>',
+			'PersonIdentificationValues' => '<value>',
+			'CommunityID' => <value>,
+			// 'GetStatsForCommunityMemberID' => NULL,
+			// 'ListOfStatisticInformationIDs' => NULL,
+			// 'OnlineTimeDuringLastXMinutes' => NULL,
+			// 'DateFormat' => 'english',
+			// 'ForumID' => 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="co_GetMemberStatistics_Pu">
+			<Parameters>
+				<Parameter Name="UniqueID"><!-- varchar value --></Parameter>
+				<Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter>
+				<Parameter Name="CommunityID"><!-- smallint value --></Parameter>
+				<!-- <Parameter Name="GetStatsForCommunityMemberID">NULL</Parameter> -->
+				<!-- <Parameter Name="ListOfStatisticInformationIDs">NULL</Parameter> -->
+				<!-- <Parameter Name="OnlineTimeDuringLastXMinutes">NULL</Parameter> -->
+				<!-- <Parameter Name="DateFormat">'english'</Parameter> -->
+				<!-- <Parameter Name="ForumID">NULL</Parameter> -->
+				<!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> -->
+			</Parameters>
+		</Procedure>
+	</Batch>
+</ListOfBatches></code>

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Unterschiede

Seiten-Werkzeuge