Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:ac_getactionlogs_ad

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:ac_getactionlogs_ad [11.01.2016 ]
engine:procedures:ac_getactionlogs_ad [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== ac_GetActionLogs_Ad =====
 +
 +Gibt "​Log-Einträge"​ einer "​Action"​ zurück.\\ ​
 +|HTTP-Method|GET |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[ac Get Action Logs Ad]}}|
 +|Engine-Kategorie|actions |
 +|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 ^
 +|__ActionID__| |ID einer "​Action"​\\ |integer|5.5.0|
 +|OnlyPartNo|NULL |Gibt an, den wievielten Eintrag man ausgegeben bekommen möchte. Zwei Sonderfälle :\\ "​NULL"​ : ALLE Einträge werden ermittelt\\ "​0"​ : der AKTUELLSTE Eintrag wird ermittelt\\ |tinyint|5.5.0|
 +==== Rückgabe ====
 +
 +=== wenn OnlyPartNo is NULL ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|PostingID|ID eines Forum-Beitrags,​ der einen Log-Eintrag (zur gegebenen "​ActionID"​) darstellt\\ |integer|5.5.0 |
 +|ReplyToPostingID|ID des Postings, auf das "​PostingID"​ eine Antwort darstellt. Falls gleich "​PostingID",​ handelt es sich um einen Haupt-Beitrag,​ sprich "​MainPosting"​\\ |integer|5.5.0 |
 +|PostDate|Datum des Beitrags "​PostingID"​\\ |datetime|5.5.0 |
 +|PostDate_char|"​PostDate"​ als String im Format : "​15.03.2001 20:​48:​13"​\\ |varchar(23)|5.5.0 |
 +|AuthorPersonID|(Person)ID des Verfassers "​Author"​ - "​0"​ bedeutet, daß der Verfasser anonym ist\\ |integer|5.5.0 |
 +|Author|Name des Verfassers des Beitrags "​PostingID"​\\ |varchar(100)|5.5.0 |
 +|EMailOfAuthor|eMail des Verfassers "​Author"​\\ |varchar(100)|5.5.0 |
 +|Subject|Der Titel des Beitrags "​PostingID"​ - enthält immer eine Zahl, die angibt, der wievielte Log-Eintrag zur "​ActionID"​ dies ist\\ |varchar(255)|5.5.0 |
 +|Body|Der Beitrag (also Log-Eintrag zur "​Action"​) selbst - "​NULL"​ falls "​SmallBody"​ NICHT "​NULL"​ ist\\ |text|5.5.0 |
 +|SmallBody|Hier erscheint der Beitrag selbst, falls er weniger als 256 Zeichen enthält UND "​UseSmallBody"​ in "​ForumSettings"​ auf "​1"​ gesetzt ist. D.h. mindestens EINE der Rückgabespalten "​SmallBody"​ und "​Body"​ ist IMMER "​NULL"​.\\ |varchar(255)|5.5.0 |
 +|Visible|Sichtbarkeits-Status des Postings "​PostingID"​. Ist immer "​4"​ oder "​8",​ da nur "​Log-Einträge",​ die in einem dieser beiden "​Visible-Status"​ sind, berücksichtigt werden.\\ |tinyint|5.5.0 |
 +|HasBinaries|Sind "​Binaries"​ zu dem Posting "​PostingID"​ vorhanden ?\\ |bit|5.5.0 |
 +|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|5.5.0 |
 +
 +== Sortierung der Rückgabe ==
 +
 +(parameterunabängige Sortierung)
 +  * PostDate (aufsteigend)
 +
 +=== wenn OnlyPartNo is NOT NULL ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|PostDate|Datum des durch "​OnlyPartNo"​ angegebenen Log-Eintrags (Format : "​15.03.2001 20:​48:​13"​)\\ |varchar(19)|5.5.0 |
 +|Author|Name des Verfassers des durch "​OnlyPartNo"​ angegebenen Log-Eintrags\\ |varchar(100)|5.5.0 |
 +|AuthorPersonID|(Person)ID des Verfassers "​Author"​ - "​0"​ bedeutet, daß der Verfasser anonym ist\\ |integer|5.5.0 |
 +|EMailOfAuthor|eMail des Verfassers "​Author"​\\ |varchar(100)|5.5.0 |
 +|Subject|Der Titel des durch "​OnlyPartNo"​ angegebenen Log-Eintrags - enthält immer eine Zahl, die angibt, der wievielte Log-Eintrag zur "​ActionID"​ dies ist. Anmerkung : Entspricht also quasi dem Wert "​OnlyPartNo"​ (außer im Sonderfall "​0"​).\\ |varchar(255)|5.5.0 |
 +|Body|Der Beitrag (also Log-Eintrag zur "​Action"​) selbst - "​NULL"​ falls "​SmallBody"​ NICHT "​NULL"​ ist\\ |text|5.5.0 |
 +|HasSuccessors|Gibt es wenigstens eine Antwort auf den Log-Eintrag ? Anmerkung : Hier sollte eigentlich immer "​0"​ stehen, wenn Log-Einträge nur mit Hilfe von [[dstoreproc>​ac_InsertActionLog_Ad]] gemacht werden.\\ |bit|5.5.0 |
 +|HasBinaries|Sind "​Binaries"​ zu dem durch "​OnlyPartNo"​ angegebenen Log-Eintrag vorhanden ?\\ |bit|5.5.0 |
 +|Value1|Hier steht die Eigenschaft von "​AuthorPersonID"​ zur ersten Merkmal-ID, die in "​ForumSettings"​ zum Schlüssel "​AllowedCharacteristicsForAdditionalInformation_<​PersonTypeID von AuthorPersonID>"​ (zum Forum "​ForumID"​) hinterlegt ist\\ |varchar(100)|5.5.0 |
 +|Value2|Hier steht die Eigenschaft von "​AuthorPersonID"​ zur zweiten Merkmal-ID, die in "​ForumSettings"​ zum Schlüssel "​AllowedCharacteristicsForAdditionalInformation_<​PersonTypeID von AuthorPersonID>"​ (zum Forum "​ForumID"​) hinterlegt ist\\ |varchar(100)|5.5.0 |
 +|Value3|Hier steht die Eigenschaft von "​AuthorPersonID"​ zur dritten Merkmal-ID, die in "​ForumSettings"​ zum Schlüssel "​AllowedCharacteristicsForAdditionalInformation_<​PersonTypeID von AuthorPersonID>"​ (zum Forum "​ForumID"​) hinterlegt ist\\ |varchar(100)|5.5.0 |
 +|SmallBody|Hier erscheint der Beitrag selbst, falls er weniger als 256 Zeichen enthält UND "​UseSmallBody"​ in "​ForumSettings"​ auf "​1"​ gesetzt ist. D.h. mindestens EINE der Rückgabespalten "​SmallBody"​ und "​Body"​ ist IMMER "​NULL"​.\\ |varchar(255)|5.5.0 |
 +|ReplyToPostingID|ID des Postings, auf den der durch "​OnlyPartNo"​ angegebene Log-Eintrag eine Antwort darstellt\\ |integer|5.5.0 |
 +|MainPostingID|ID des Haupt-Beitrages zu dem durch "​OnlyPartNo"​ angegebene Log-Eintrag (also sozusagen das Wurzel-Element des gesamten "​Threads"​)\\ |integer|5.5.0 |
 +|Visible|Sichtbarkeits-Status des durch "​OnlyPartNo"​ angegebenen Log-Eintrags - mögliche Werte : siehe [[dstoreproc>​fo_GetPostingVisibilities]]\\ |tinyint|5.5.0 |
 +|ForumID|ID des Forums zu dem der durch "​OnlyPartNo"​ angegebenene Log-Eintrag gehört\\ |smallint|5.5.0 |
 +==== 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"​)) ^
 +|-805|Keine Berechtigung zum Löschen von Postings|nur indirekt|
 +|-802|Keine Berechtigung zum Bestätigen von Postings des Forums|nur indirekt|
 +|-801|Kein lesender Zugriff auf das Forum|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|
 +|-556|Fehlender oder falscher Eintrag in CommandSettings|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|Interne Änderung : Datentyp-Erweiterung des "​ReferenceKey"​ [für "​_mi_StartProcedure"​-Aufruf]\\ ​ |
 +|6.0.2 |2011-06-08|Schlechte queries bzgl. Ermittlung der zur "​ActionID"​ zugehörigen "​PostingIDs"​ geändert => Deutliche Performance-\\ Verbesserung\\ ​ |
 +|5.5.0 |2008-01-07|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=ac_GetActionLogs_Ad|ac_GetActionLogs_Ad im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​ac_GetActionLogs_Ad?​ActionID=<​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/​ac_GetActionLogs_Ad?​ActionID=<​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'​),​
 + '​ac_GetActionLogs_Ad',​
 + array(
 + '​ActionID'​ => <​value>,​
 + // '​OnlyPartNo'​ => NULL
 + )
 +);
 +
 +$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="​ac_GetActionLogs_Ad">​
 + <​Parameters>​
 + <​Parameter Name="​ActionID"><​!-- integer value --></​Parameter>​
 + <!-- <​Parameter Name="​OnlyPartNo">​NULL</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/ac_getactionlogs_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)