Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

@@ Zeile 1: / Zeile 1: @@
+===== co_CreateNewMessage_Pu =====
+Erstellt eine neue Kurznachricht von einem Community-Mitglied an ein anderes.\\
+|HTTP-Method|POST |
+|HTTP-Auth|Optional |
+|Tags|{{tag>[co Create New Message Pu]}}|
+|Engine-Kategorie|communities |
+|Engine-Typ|Daten-Änderung |
+|Letzte Aktualisierung|6.5.4 (2013-04-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 ^
+|__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|NULL |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|
+|__ToCommunityMemberID__| |ID eines anderen Mitglieds der "CommunityID", an das eine Nachricht verschickt werden soll\\ |integer|3.5.0|
+|__Message__| |Die zu erstellende Nachricht\\ |varchar(255)|3.5.0|
+|MessageStatus|0 |Status der Nachricht. Muß kleiner als 99 sein, weil :\\ * 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.2|
+|SeparatorInIdentVals|'¶' |Gibt an, durch welche Zeichenkette die Werte in "PersonIdentificationValues" getrennt sind\\ |varchar(4)|5.5.0|
+==== Rückgabe ====
+Die Prozedur hat keine Rückgaben.
+==== 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|
+|-721|Spam-Schutz: Message wurde nicht angenommen|nur direkt|
+|-720|Fehlende Berechtigung zum Erstellen von Messages|nur direkt|
+|-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|Datentyp des Parameters "SeparatorInIdentVals" wg. UTF-8 Unterstützung auf "varchar[4]" erweitert\\  |
+|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\\  |
+|4.0.6 |2003-11-14|Maßnahme bei der letzten Änderung dieser Prozedur : "Verhindern, daß es mehrfache Datensätze mit gleicher "CommunityID", "FromCommunityMemberID" und "MessageDateAndTime" gibt". Dies hat nicht funktioniert, daher wurde nachgebessert.\\  |
+|4.0.3 |2003-07-10|Verhindern, daß es einen Datensatz mit "CommunityID, FromCommunityMemberID, MessageDateAndTime" mehrfach gibt - in diesem Fall wird ebenfalls "-721" zurückgegeben\\  |
+|3.5.20 |2002-07-22|\\  |
+|3.5.15 |2002-03-12|\\  |
+|3.5.14 |2002-01-23|\\  |
+|3.5.2 |2001-01-28|\\  |
+|3.5.0 |2000-11-23|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_CreateNewMessage_Pu|co_CreateNewMessage_Pu im Engine Playground öffnen]]
+== cURL ==
+Unformatierte Ausgabe:
+<code bash>
+curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/co_CreateNewMessage_Pu?UniqueID=<value>&CommunityID=<value>&ToCommunityMemberID=<value>&Message=<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 POST  'http://<partner>-<project>.dstore.de/default/engine/co_CreateNewMessage_Pu?UniqueID=<value>&CommunityID=<value>&ToCommunityMemberID=<value>&Message=<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_CreateNewMessage_Pu',
+		array(
+			'UniqueID' => '<value>',
+			'CommunityID' => <value>,
+			'ToCommunityMemberID' => <value>,
+			'Message' => '<value>',
+			// 'PersonIdentificationValues' => NULL,
+			// 'MessageStatus' => 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_CreateNewMessage_Pu">
+			<Parameters>
+				<Parameter Name="UniqueID"><!-- varchar value --></Parameter>
+				<Parameter Name="CommunityID"><!-- smallint value --></Parameter>
+				<Parameter Name="ToCommunityMemberID"><!-- integer value --></Parameter>
+				<Parameter Name="Message"><!-- varchar value --></Parameter>
+				<!-- <Parameter Name="PersonIdentificationValues">NULL</Parameter> -->
+				<!-- <Parameter Name="MessageStatus">0</Parameter> -->
+				<!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> -->
+			</Parameters>
+		</Procedure>
+	</Batch>
+</ListOfBatches></code>

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Unterschiede

Seiten-Werkzeuge