Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:co_getsentmessages_pu

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:co_getsentmessages_pu [11.01.2016 ]
engine:procedures:co_getsentmessages_pu [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== co_GetSentMessages_Pu =====
 +
 +Gibt die Nachrichten aus, die ein Community-Mitglied selbst verschickt hat.\\ ​
 +
 +
 +
 +Anmerkung zum Parameter "​DateAndTimeFormat"​ :\\ 
 +
 +Die Möglichkeiten für diesen Parameter sind exakt die, die der ASE in der Funktion "​convert"​ für Datums-Formatierungen bietet (in Klammern ist das Format angegeben, um in der Jahreszahl das Jahrhundert angezeigt zu bekommen) :\\ 
 +
 +   * (0 or 100) : mon dd yyyy hh:mm AM (or PM)
 + 1 (101) : mm/​dd/​yy\\ ​ 2 : yy.mm.dd\\ ​ 3 (103) : dd/​mm/​yy\\ ​ 4 (104) : dd.mm.yy\\ ​ 5 (105) : dd-mm-yy\\ ​ 6 (106) : dd mon yy\\  7 (107) : mon dd, yy\\  8 (108) : hh:mm:ss
 +   * (9 or 109) : mon dd yyyy hh:mm:sss AM (or PM)
 +10 (110) : mm-dd-yy\\ 11 (111) : yy/mm/dd\\ 12 (112) : yymmdd\\ ​
 +
 +
 +
 +Anmerkung zur "​MessageNo"​ :\\ 
 +
 +Gibt an, um die wievielte Nachricht es sich für den Adressaten der Nachricht handelt. Allerdings werden negative Werte zurückgegeben ! Hintergrund : Der ASE (in der Version 11.0.3) erlaubt nur aufsteigende Indizes. Da man aber im Regelfall immer die aktuellsten Messages ZUERST sehen möchte, enthält die "​MessageNo"​ negative integer-Werte,​ um zur Sortierung einen Index nutzen zu können.\\ ​
 +
 +
 +
 +Anmerkung zur Rückgabespalte "​ToCommunityMember_Nickname"​ :\\ 
 +
 +Eine evtl. konfigurierte Zugriffsbeschränkung für das "​Nickname"​-Merkmal (s. [[dstoreproc>​pm_GetPChAccRestrForUsers_Ad]]) wird bewußt NICHT beachtet (da das ja DIE öffentlich sichtbare Eigenschaft in einer Community schlechthin ist) !\\ 
 +|HTTP-Method|GET |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[co Get Sent Messages Pu]}}|
 +|Engine-Kategorie|communities |
 +|Engine-Typ|Daten-Ermittlung |
 +|Letzte Aktualisierung|6.5.4 (2013-04-29)|
 +
 +==== Parameter ====
 +
 +|__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.4|
 +|__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.4|
 +|__CommunityID__| |ID einer Community\\ |smallint|3.5.4|
 +|OnlyMessagesToMemberID|NULL |ID eines anderen Mitglieds der Community "​CommunityID"​. Falls angegeben, werden nur die an dieses Mitglied geschickten Nachrichten ausgegeben.\\ |integer|4.0.3|
 +|DateAndTimeFormat|NULL |Gibt an, wie "​MessageDateAndTime_char"​ im Ergebnis formatiert sein soll. "​NULL"​ bedeutet, daß das Format "​07.02.2000 17:​30:​21"​ gewählt wird. Ansonsten wird der Parameter für die "​style"​-Option der ASE-Funktion "​convert"​ verwendet (siehe Beschreibung).\\ |tinyint|3.5.4|
 +|FromRowNumber|1 |Es werden maximal "​MaxNumberOfRows"​ (also höchstens 255) Datensätze ausgegeben. Mit Hilfe dieses Parameters (und "​MaxNumberOfRows"​) kann man sich aber durch das Gesamtergebnis "​blättern"​.\\ |integer|4.0.3|
 +|MaxNumberOfRows|20 |Gibt an, wieviele Nachrichten maximal zurückgegeben werden sollen. Mit diesem Parameter sowie "​FromRowNumber"​ kann man sich durch die Nachrichten "​blättern"​. ("​0"​ ist nicht erlaubt, bei Angabe von "​NULL"​ werden maximal 255 Datensätze zurückgegeben !)\\ |tinyint|3.5.4|
 +|FromMessageStatus|NULL |Falls angegeben, werden nur verschickte Nachrichten ausgegeben, die aktuell in einem Status sind, der größer-gleich diesem Wert ist\\ |tinyint|4.0.3|
 +|ToMessageStatus|NULL |Falls angegeben, werden nur verschickte Nachrichten ausgegeben, die aktuell in einem Status sind, der kleiner-gleich diesem Wert ist\\ |tinyint|4.0.3|
 +|OrderDesc|1 |Die Sortierung der Rückgabemenge richtet sich immer (u.a.) nach dem "​MessageDateAndTime"​ der Nachrichten. Hierdurch wird angegeben, ob aufsteigend ("​0"​) oder absteigend ("​1"​) nach "​MessageDateAndTime"​ sortiert werden soll.\\ |bit|4.0.3|
 +|OrderByNick|0 |"​0"​ : Das Ergebnis wird nur nach "​MessageDateAndTime"​ sortiert\\ "​1"​ : Es wird zuerst aufsteigend nach "​ToCommunityMember_Nickname"​ (lowercase) sortiert, dann nach "​MessageDateAndTime"​\\ |bit|4.0.3|
 +|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 ^
 +|//​lower(ToCommunityMember_Nickname)((Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.))//​|Wird nicht zurückgegeben,​ sondern zur Sortierung benötigt; enthält den "​ToCommunityMemberNickname"​ komplett "​lowercase"​ (Kleinbuchstaben)\\ |varchar(100)|4.0.3 |
 +|ToCommunityMemberID|Adressat der Nachricht "​Message"​\\ |integer|3.5.4 |
 +|ToCommunityMember_Nickname|Eigenschaft des Mitglieds "​ToCommunityMemberID"​ zu dem Merkmal, anhand dessen die Communitymitglieder sich untereinander unterscheiden bzw. erkennen können. (Eintrag in "​CommunitySettings"​ zum Schlüssel "​IdentifyingCharacteristicID"​)\\ |varchar(100)|3.5.4 |
 +|MessageNo|Nummer der Nachricht "​Message"​. Gibt an, um die wievielte Nachricht es sich für das Mitglied "​ToCommunityMemberID"​ handelt. ACHTUNG : es werden negative Werte zurückgegeben (s. Beschreibung) !\\ |integer|3.5.4 |
 +|MessageStatus|Status der Nachricht "​Message"​. Bedeutung(en) :\\ * 0 bis 99 : neu (ungelesen) ​  (z.B könnte "​1"​ bedeuten, "​Schicke es auch als SMS"​)\\ * 100 bis 199 : alt (gelesen)\\ * 200 bis 254 : <​undefiniert>​\\ * 255 : gelöscht\\ |tinyint|3.5.4 |
 +|MessageDateAndTime|Wann wurde die Nachricht "​Message"​ geschickt\\ |datetime|3.5.4 |
 +|MessageDateAndTime_char|"​MessageDateAndTime"​ als String. Falls "​DateAndTimeFormat = NULL" übergeben wurde, ist das Format "​07.02.2000 17:​30:​21"​. Ansonsten wird "​DateAndTimeFormat"​ für die "​style"​-Option der ASE-Funktion "​convert"​ verwendet (siehe Beschreibung).\\ |varchar(25)|4.0.3 |
 +|Message|Die Nachricht an "​ToCommunityMemberID"​ (des durch "​PersonIdentificationValues"​ identifizierte Community-Mitglieds)\\ |varchar(255)|3.5.4 |
 +
 +== Sortierungen der Rückgabe ==
 +
 +wenn OrderDesc = 0 und OrderByNick = 0
 +  * MessageDateAndTime (aufsteigend)
 +wenn OrderDesc = 1 und OrderByNick = 0
 +  * MessageDateAndTime (absteigend)
 +wenn OrderDesc = 0 und OrderByNick = 1
 +  * lower(ToCommunityMember_Nickname) (aufsteigend)
 +  * MessageDateAndTime (aufsteigend)
 +wenn OrderDesc = 1 und OrderByNick = 1
 +  * lower(ToCommunityMember_Nickname) (aufsteigend)
 +  * MessageDateAndTime (absteigend)
 +
 +==== 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|1. Hinweis in der Doku, daß bewusst NICHT eine evtl. konfigurierte Zugriffsbeschränkung für das "​Nickname"​-Merkmal beachtet wird (da ja DIE öffentlich sichtbare Eigenschaft)\\ 2. Datentyp-Erweiterung von "​SeparatorInIdentVals"​ [von "​1"​ auf "​4"​]\\ ​ |
 +|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.0.1 |2005-03-29|1. Überarbeitung interner Fallunterscheidung zwecks Reduzierung von "​reads"​ => Performance-Verbesserung\\ 2. Konsequente Fehlerbehandlung\\ ​ |
 +|4.0.3 |2003-07-10|1. Komplette Überarbeitung der Prozedur\\ 2. Änderung des Parameters "​MessageNo"​ in "​FromRowNumber"​\\ 3. Neue Parameter "​OnlyMessagesToMemberID",​ "​OrderDesc",​ "​OrderByNick"​\\ ​ |
 +|3.5.4 |2001-03-11|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_GetSentMessages_Pu|co_GetSentMessages_Pu im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​co_GetSentMessages_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_GetSentMessages_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_GetSentMessages_Pu',​
 + array(
 + '​UniqueID'​ => '<​value>',​
 + '​PersonIdentificationValues'​ => '<​value>',​
 + '​CommunityID'​ => <​value>,​
 + // '​OnlyMessagesToMemberID'​ => NULL,
 + // '​DateAndTimeFormat'​ => NULL,
 + // '​FromRowNumber'​ => 1,
 + // '​MaxNumberOfRows'​ => 20,
 + // '​FromMessageStatus'​ => NULL,
 + // '​ToMessageStatus'​ => NULL,
 + // '​OrderDesc'​ => 1,
 + // '​OrderByNick'​ => 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="​co_GetSentMessages_Pu">​
 + <​Parameters>​
 + <​Parameter Name="​UniqueID"><​!-- varchar value --></​Parameter>​
 + <​Parameter Name="​PersonIdentificationValues"><​!-- varchar value --></​Parameter>​
 + <​Parameter Name="​CommunityID"><​!-- smallint value --></​Parameter>​
 + <!-- <​Parameter Name="​OnlyMessagesToMemberID">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​DateAndTimeFormat">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​FromRowNumber">​1</​Parameter>​ -->
 + <!-- <​Parameter Name="​MaxNumberOfRows">​20</​Parameter>​ -->
 + <!-- <​Parameter Name="​FromMessageStatus">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​ToMessageStatus">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​OrderDesc">​1</​Parameter>​ -->
 + <!-- <​Parameter Name="​OrderByNick">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​SeparatorInIdentVals">'​¶'</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/co_getsentmessages_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)