Gibt alle Nachrichten aus „Messages“ (optional in einem bestimmten Zeitraum) eines Community-Mitglieds zurück. Dabei kann über eine bestimmte Community eingeschränkt und angegeben werden, ob
Nachrichten zurückgegeben werden sollen.
Anmerkung zu den Rückgabespalten „FromCommunityMember“ und „ToCommunityMember“ :
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 | 7.0.7 (2015-01-29) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
CommunityMemberID | ID eines Community-Mitglieds | integer | 3.5.8 | |
CommunityID | NULL | ID einer Community. Falls angegeben, sollen nur die Nachrichten dieser Community berücksichtigt werden | smallint | 3.5.8 |
CommunicatingMemberID | NULL | ID eines Community-Mitglieds. Ist dieser Parameter angegeben, gibt die Prozedur nur die Nachrichten zurück, die AN dieses Mitglied oder von diesem Mitglied gesendet wurden (je nach „SentOrReceivedMessages“). | integer | 3.5.8 |
SentOrReceivedMessages | 0 | „0“ : nur die verschickten Nachrichten „1“ : nur die erhaltenen Nachrichten „2“ : sowohl die verschickten als auch die erhaltenen Nachrichten | tinyint | 3.5.8 |
FromDate | NULL | Falls angegeben, werden nur Nachrichten berücksichtigt, die NACH diesem Datum erstellt wurden | datetime | 3.5.8 |
ToDate | NULL | Falls angegeben, werden nur Nachrichten berücksichtigt, die VOR diesem Datum erstellt wurden | datetime | 3.5.8 |
OrderByMessageDateAndTime | 0 | Die Rückgabemenge wird aufsteigend nach „CommuntiyName“ sortiert, und dann nach… „0“ : „FromCommunityMember“ (aufsteigend), „MessageDateAndTime“ (absteigend) „1“ : „MessageDateAndTime“ (aufsteigend) „2“ : „MessageDateAndTime“ (absteigend) | tinyint | 3.5.13 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
CommunityID | ID der Community, in der die Nachricht von „FromCommunityMemberID“ an „ToCommunityMemberID“ (zum Zeitpunkt „MessageDateAndTime“) verschickt wurde | smallint | 3.5.8 |
CommunityName | Name der Community „CommunityID“ | varchar(100) | 3.5.8 |
FromCommunityMemberID | ID des Mitglieds der Commuity „CommunityID“, das die Nachricht an „ToCommunityMemberID“ (zum Zeitpunkt „MessageDateAndTime“) verschickt hat | integer | 3.5.8 |
FromCommunityMember | Eigenschaft des Mitglieds „FromCommunityMemberID“ zum Merkmal mit der „IdentifyingCharacteristicID“ (aus „CommunitySettings“) | varchar(100) | 3.5.8 |
ToCommunityMemberID | ID des Mitglieds der Commuity „CommunityID“, das die Nachricht von „FromCommunityMemberID“ (zum Zeitpunkt „MessageDateAndTime“) erhalten hat | integer | 3.5.8 |
ToCommunityMember | Eigenschaft des Mitglieds „ToCommunityMemberID“ zum Merkmal mit der „IdentifyingCharacteristicID“ (aus „CommunitySettings“) | varchar(100) | 3.5.8 |
Message | Die Nachricht, die von „FromCommunityMemberID“ an „ToCommunityMemberID“ (zum Zeitpunkt „MessageDateAndTime“) verschickt wurde | varchar(255) | 3.5.8 |
MessageDateAndTime | Zeitpunkt an dem die Nachricht „Message“ von „FromCommunityMemberID“ an „ToCommunityMemberID“ verschickt wurde | datetime | 3.5.8 |
MessageDateAndTime_char | „MessageDateAndTime“ als String (Format „15.04.2001 20:56:39“) | varchar(19) | 3.5.8 |
MessageStatus | Status der Nachricht „Message“, die von „FromCommunityMemberID“ an „ToCommunityMemberID“ (zum Zeitpunkt „MessageDateAndTime“) verschickt wurde : * 0 bis 99 : neu (ungelesen) * 100 bis 199 : alt (gelesen) * 200 bis 254 : <undefiniert> * 255 : gelöscht | tinyint | 3.5.8 |
wenn OrderByMessageDateAndTime = 0
wenn OrderByMessageDateAndTime = 1
wenn OrderByMessageDateAndTime = 2
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 5) |
---|---|---|
-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 |
-500 | Falsche Parameter | direkt und indirekt |
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
7.0.7 | 2015-01-29 | Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf] |
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. Anpassungen des Quellcodes an den aktuellen Standard |
4.0.10 | 2004-03-15 | 1. Aufruf der Prozeduren „_mi_StartProcedure“ und „_mi_FinishProcedure“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur |
3.5.13 | 2001-12-06 | |
3.5.8 | 2001-05-19 | 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_GetMessagesOfOneMember_Ad?CommunityMemberID=<value>'
Mit xmllint 6) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/co_GetMessagesOfOneMember_Ad?CommunityMemberID=<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_GetMessagesOfOneMember_Ad', array( 'CommunityMemberID' => <value>, // 'CommunityID' => NULL, // 'CommunicatingMemberID' => NULL, // 'SentOrReceivedMessages' => 0, // 'FromDate' => NULL, // 'ToDate' => NULL, // 'OrderByMessageDateAndTime' => 0 ) ); $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_GetMessagesOfOneMember_Ad"> <Parameters> <Parameter Name="CommunityMemberID"><!-- integer value --></Parameter> <!-- <Parameter Name="CommunityID">NULL</Parameter> --> <!-- <Parameter Name="CommunicatingMemberID">NULL</Parameter> --> <!-- <Parameter Name="SentOrReceivedMessages">0</Parameter> --> <!-- <Parameter Name="FromDate">NULL</Parameter> --> <!-- <Parameter Name="ToDate">NULL</Parameter> --> <!-- <Parameter Name="OrderByMessageDateAndTime">0</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>