Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
— |
engine:procedures:co_getcommunitystatistics_ad [11.01.2016 ] (aktuell) |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
+ | ===== co_GetCommunityStatistics_Ad ===== | ||
+ | |||
+ | Gibt statistische Informationen zu allen Communities (oder nur zu einer bestimmten Community) innerhalb eines Zeitraums aus.\\ | ||
+ | |||
+ | ACHTUNG: Im Falle "CalculateSum = 1" wird kein Wert zur Information "Mitglieder gesamt" ("StatisticInformationID = 5") geliefert (da dieser Wert immer pro Tag gilt und ein kummulierter Wert keinen Sinn ergibt) !\\ | ||
+ | |HTTP-Method|GET | | ||
+ | |HTTP-Auth|Optional | | ||
+ | |Tags|{{tag>[co Get Community Statistics Ad]}}| | ||
+ | |Engine-Kategorie|communities | | ||
+ | |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 ^ | ||
+ | |CommunityID|NULL |ID einer Community\\ |smallint|3.5.15| | ||
+ | |StatisticInformationIDList|NULL |Es gibt bestimmte statistische Informationen (z.B. die Anzahl Logins) die der "dStore" pro Community zur Verfügung stellt. Möchte man nur bestimmte Informationen anzeigen lassen, gibt man hier eine Liste der entsprechenden IDs (durch '¶' getrennt) an.\\ |varchar(255)|3.5.15| | ||
+ | |FromDate|NULL |Startzeitpunkt des Zeitraums, zu dem man sich Statistiken ausgeben lassen möchte\\ |datetime|3.5.15| | ||
+ | |ToDate|NULL |Endzeitpunkt des Zeitraums, zu dem man sich Statistiken ausgeben lassen möchte\\ |datetime|3.5.15| | ||
+ | |CalculateSum|0 |Je nach Einstellung gibt es verschiedene Rückgabemengen...\\ "0" : Die statistischen Werte sind PRO TAG angegeben\\ "1" : Es wird für jede "StatisticInformationID" EIN Datensatz (nämlich die Summe über den gesamten Zeitraum) ausgegeben\\ |bit|3.5.15| | ||
+ | ==== Rückgabe ==== | ||
+ | |||
+ | === wenn CalculateSum = 0 === | ||
+ | |||
+ | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
+ | |CommunityID|ID einer Community auf die sich die Statistiken beziehen\\ |smallint|3.5.15 | | ||
+ | |CommunityName|Name der Community "CommunityID"\\ |varchar(100)|3.5.15 | | ||
+ | |StatisticInformationID|ID einer statistischen Information\\ |tinyint|3.5.15 | | ||
+ | |StatisticInformation|Bezeichnung der statistischen Information "StatisticInformationID" (z.B. "Online-Minuten", "Logins" etc.)\\ |varchar(100)|3.5.15 | | ||
+ | |Description|Genauere Beschreibung, was unter der Information "StatisticInformationID" zu verstehen ist\\ |varchar(255)|3.5.15 | | ||
+ | |IsPublic|Handelt es sich um eine statistische Information, die dem öffentlichen Benutzer ausgegeben werden darf ? Wird derzeit nicht beachtet !\\ |bit|3.5.15 | | ||
+ | |Day|Tagesdatum, auf das sich der Wert "Value" bezieht. Es ist für jeden Tag im Zeitraum "FromDate" bis "ToDate" ein Datensatz vorhanden !\\ |datetime|3.5.15 | | ||
+ | |Value|Der statistische Wert zur "StatisticInformationID" in der Community "CommunityID" am Tag "Day"\\ |decimal(12,2)|3.5.15 | | ||
+ | === wenn CalculateSum = 1 === | ||
+ | |||
+ | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
+ | |CommunityID|ID einer Community auf die sich die Statistiken beziehen\\ |smallint|3.5.15 | | ||
+ | |CommunityName|Name der Community "CommunityID"\\ |varchar(100)|3.5.15 | | ||
+ | |StatisticInformationID|ID einer statistischen Information\\ |tinyint|3.5.15 | | ||
+ | |StatisticInformation|Bezeichnung der statistischen Information "StatisticInformationID" (z.B. "Online-Minuten", "Logins" etc.)\\ |varchar(100)|3.5.15 | | ||
+ | |Description|Genauere Beschreibung, was unter der Information "StatisticInformationID" zu verstehen ist\\ |varchar(255)|3.5.15 | | ||
+ | |IsPublic|Handelt es sich um eine statistische Information, die dem öffentlichen Benutzer ausgegeben werden darf ? Wird derzeit nicht beachtet !\\ |bit|3.5.15 | | ||
+ | |Value|Der statistische Wert zur "StatisticInformationID" in der Community "CommunityID" im Zeitraum "FromDate" bis "ToDate"\\ |decimal(12,2)|3.5.15 | | ||
+ | ==== 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")) ^ | ||
+ | |-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|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|Interne Änderung : Datentyp-Erweiterung des "ReferenceKey" [für "_mi_StartProcedure"-Aufruf]\\ | | ||
+ | |6.5.4 |2013-04-29|Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung\\ | | ||
+ | |4.0.10 |2004-03-15|1. "_mi_StartProcedure", "_mi_FinishProcedure" und "_mi_ChooseParamValueSeperator"\\ 2. "set transaction isolation level 1", "set rowcount 0"\\ 3. Konsequente Fehlerbehandlung\\ 4. Überarbeitung der Doku\\ 5. Interner Fehler\\ 6. Kl. Performance-Verbesserung\\ | | ||
+ | |3.5.16 |2002-04-25|\\ | | ||
+ | |3.5.15 |2002-03-12|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_GetCommunityStatistics_Ad|co_GetCommunityStatistics_Ad im Engine Playground öffnen]] | ||
+ | == cURL == | ||
+ | Unformatierte Ausgabe: | ||
+ | <code bash> | ||
+ | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/co_GetCommunityStatistics_Ad'</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_GetCommunityStatistics_Ad' | 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_GetCommunityStatistics_Ad', | ||
+ | array( | ||
+ | // 'CommunityID' => NULL, | ||
+ | // 'StatisticInformationIDList' => NULL, | ||
+ | // 'FromDate' => NULL, | ||
+ | // 'ToDate' => NULL, | ||
+ | // 'CalculateSum' => 0 | ||
+ | ) | ||
+ | ); | ||
+ | |||
+ | $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_GetCommunityStatistics_Ad"> | ||
+ | <Parameters> | ||
+ | <!-- <Parameter Name="CommunityID">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="StatisticInformationIDList">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="FromDate">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="ToDate">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="CalculateSum">0</Parameter> --> | ||
+ | </Parameters> | ||
+ | </Procedure> | ||
+ | </Batch> | ||
+ | </ListOfBatches></code> | ||