Prozedur, um sich „Settings“-Einträge eines Community-Mitglieds anzeigen zu lassen.
Anmerkung:
Sind „Settings“-Einträge zu einem ANDEREN Community-Mitglied gefragt, werden nur Schlüssel berücksichtigt, die NICHT mit „sys_“ beginnen !
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.14 | |
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.14 | |
CommunityID | ID einer Community, in der die identifizierte Person Mitglied ist | smallint | 3.5.14 | |
GetEntryForCommunityMemberID | NULL | ID eines Mitglieds der Community „CommunityID“. „NULL“ heißt, daß die „Settings“-Einträge zum identifizierten Mitglied ermittelt werden. Falls Einträge zu einem ANDEREN Mitglied gewünscht sind, sind nur Schlüssel erlaubt, die NICHT mit „sys“ beginnen ! | integer | 3.5.14 |
KeyVariable | NULL | Ein Schlüssel aus „CommunityMemberSettings“, zu dem der für das Mitglied „GetEntryForCommunityMemberID“ hinterlegte Wert zurückgegeben werden soll. „NULL“ bedeutet, daß man die Werte zu ALLEN Schlüsseln zurückbekommen möchte. | varchar(100) | 3.5.14 |
SeparatorInIdentVals | '¶' | Gibt an, durch welche Zeichenkette die Werte in „PersonIdentificationValues“ getrennt sind | varchar(4) | 5.5.0 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
KeyVariable | Ein Schlüssel aus „CommunityMemberSettings“ bzw. „KeyVariable“ | varchar(50) | 3.5.14 |
Value | Der zum Schlüssel „KeyVariable“ hinterlegte Wert des Mitglieds „GetEntryForCommunityMemberID“ in der Community „CommunityID“ | varchar(100) | 3.5.14 |
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 5) |
---|---|---|
-782 | Der Settings-Eintrag darf nur vom Mitglied selbst oder von einem Administrator eingesehen werden | nur direkt |
-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 | nur indirekt |
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
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. Bearbeitung des Quellcodes hinsichtlich neuer Konventionen |
3.5.14 | 2002-01-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_GetMemberSettings_Pu?UniqueID=<value>&PersonIdentificationValues=<value>&CommunityID=<value>'
Mit xmllint 6) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/co_GetMemberSettings_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_GetMemberSettings_Pu', array( 'UniqueID' => '<value>', 'PersonIdentificationValues' => '<value>', 'CommunityID' => <value>, // 'GetEntryForCommunityMemberID' => NULL, // 'KeyVariable' => NULL, // '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_GetMemberSettings_Pu"> <Parameters> <Parameter Name="UniqueID"><!-- varchar value --></Parameter> <Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter> <Parameter Name="CommunityID"><!-- smallint value --></Parameter> <!-- <Parameter Name="GetEntryForCommunityMemberID">NULL</Parameter> --> <!-- <Parameter Name="KeyVariable">NULL</Parameter> --> <!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>