Gibt die (erhaltenen) Nachrichten eines Community-Mitglieds aus.
Ausgegebene Nachrichten werden danach, falls dies noch nicht geschehen ist, als gelesen markiert, das bedeutet, der Status einer ungelesenen Nachricht wird um 100 erhöht. Hier die Bedeutung(en) des Status :
Aus Performance-Gründen wurde der Parameter „GetNewMessages“ eingeführt und die „Blättern“-Funktionalität (mit „MessageNo“ und „MaxNumberOfMessages“) auf den Fall beschränkt, daß man sich ALLE Nachrichten („GetNewMessages = 0“) anzeigen lassen möchte.
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) :
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
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 das (durch „PersonIdentificationValues“ identifizierte) Mitglied 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 „FromCommunityMember_Nickname“ :
Eine evtl. konfigurierte Zugriffsbeschränkung für das „Nickname“-Merkmal (s. 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 | |
Engine-Kategorie | communities |
Engine-Typ | Daten-Ermittlung |
Letzte Aktualisierung | 6.5.4 (2013-04-29) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | 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.0 | |
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.0 | |
CommunityID | ID einer Community | smallint | 3.5.0 | |
GetNewMessages | 1 | „0“ : Alte (sprich „gelesene“) Nachrichten (mit „MessageStatus >= 100“) anzeigen „1“ : Nur neue (sprich „ungelesene“) Nachrichten (mit „MessageStatus < 100“) anzeigen | bit | 3.5.2 |
DateAndTimeFormat | NULL | Gibt an, wie „MessageDateAndTime“ in der Rückgabemenge 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.0 |
MessageNo | NULL | Wird NUR im Fall „GetNewMessages = 0“ beachtet ! Gibt an, ab welcher Nachricht die Ausgabe beginnen soll. Mit diesem Parameter sowie „MaxNumberOfRows“ kann man sich durch die Nachrichten „blättern“. | integer | 3.5.0 |
MaxNumberOfRows | 20 | Wird NUR im Fall „GetNewMessages = 0“ beachtet ! Gibt an, wieviele Nachrichten maximal zurückgegeben werden sollen. Mit diesem Parameter sowie „MessageNo“ kann man sich durch die Nachrichten „blättern“. („0“ und „NULL“ sind nicht erlaubt !) | tinyint | 3.5.0 |
SeparatorInIdentVals | '¶' | Gibt an, durch welche Zeichenkette die Werte in „PersonIdentificationValues“ getrennt sind | varchar(4) | 5.5.0 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
MessageNo | Nummer der Nachricht „Message“. Gibt an, um die wievielte Nachricht es sich für das (durch „PersonIdentificationValues“ identifizierte) Mitglied handelt. ACHTUNG : es werden negative Werte zurückgegeben ! | integer | 3.5.0 |
FromCommunityMemberID | ID des Community-Mitglieds, von dem die Nachricht „Message“ stammt | integer | 3.5.0 |
FromCommunityMember_Nickname | Eigenschaft des Mitglieds „FromCommunityMemberID“ 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.0 |
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.0 |
MessageDateAndTime | Wann wurde die Nachricht „Message“ geschickt. 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). | datetime | 3.5.0 |
Message | Die Nachricht von „FromCommunityMemberID“ an das (durch „PersonIdentificationValues“ identifizierte) Community-Mitglied | varchar(255) | 3.5.0 |
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 5) |
---|---|---|
-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 |
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
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 via „print“ im Fehler-Fall „-500“, die nähere Informationen über die Ursache enthält 3. Bearbeitung des Quellcodes hinsichtlich neuer Konventionen |
4.0.2 | 2003-06-11 | In einem Fall wurde GAR KEIN Ergebnis anstelle einer leeren Ergebnismenge zurückgegeben ! |
3.5.2 | 2001-01-28 | |
3.5.0 | 2000-11-23 | Erstmalig in dieser Version erstellt |
Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
Unformatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/co_GetMessages_Pu?UniqueID=<value>&PersonIdentificationValues=<value>&CommunityID=<value>'
Mit xmllint 6) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/co_GetMessages_Pu?UniqueID=<value>&PersonIdentificationValues=<value>&CommunityID=<value>' | xmllint --format -
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_GetMessages_Pu', array( 'UniqueID' => '<value>', 'PersonIdentificationValues' => '<value>', 'CommunityID' => <value>, // 'GetNewMessages' => 1, // 'DateAndTimeFormat' => NULL, // 'MessageNo' => NULL, // 'MaxNumberOfRows' => 20, // 'SeparatorInIdentVals' => '¶' ) ); $service->execute($request); $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); $ResultSet = $xml_result->getRowsAsArray();
XML zur Ausführung mit der Methode engine/execute, z.B. per
curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>'
<?xml version="1.0" encoding="UTF-8"?> <ListOfBatches> <Batch No="0"> <Procedure Name="co_GetMessages_Pu"> <Parameters> <Parameter Name="UniqueID"><!-- varchar value --></Parameter> <Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter> <Parameter Name="CommunityID"><!-- smallint value --></Parameter> <!-- <Parameter Name="GetNewMessages">1</Parameter> --> <!-- <Parameter Name="DateAndTimeFormat">NULL</Parameter> --> <!-- <Parameter Name="MessageNo">NULL</Parameter> --> <!-- <Parameter Name="MaxNumberOfRows">20</Parameter> --> <!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>