Benutzer-Werkzeuge

Webseiten-Werkzeuge

Action disabled: source

engine:procedures:co_getrelatedmembers_pu

co_GetRelatedMembers_Pu

Gibt für ein Community-Mitglied alle „Mitglieder“ zurück, die in einer bestimmten Beziehung ihm stehen, wie z.B. alle „Freunde“ (→ Eintrag in „CommunitySettings“ zum Schlüssel „FriendRelationshipID“).

Anmerkung zu den „OutputCharacteristicID…“-Parametern :

IDs, die hier übergeben werden und nicht für den Benutzer, der diese Prozedur aufruft, „sichtbar“ sind (aufgrund von Zugriffsbeschränkungen, s. pm_GetPChAccRestrForUsers_Ad), werden grundsätzlich ignoriert ! D.h. es gibt zwar keinen Fehler, aber die entsprechende(n) Eigenschaft(en) werden natürlich nicht zurückgegeben !

Anmerkung zur Rückgabespalte „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-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategoriecommunities
Engine-TypDaten-Ermittlung
Letzte Aktualisierung6.5.4 (2013-04-29)

Parameter

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.11
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.11
CommunityID ID einer Community
smallint3.5.11
CommunityMemberIDNULL ID eines anderen Community-Mitglieds. So kann man überprüfen, ob eine Beziehung zu genau dieser Person besteht oder nicht (wenn nicht, ist die Ergebnismenge leer). Die Person muß natürlich Mitglied der gleichen Community sein…
integer3.5.11
RelationshipIDNULL Gibt an, welcher Art die „Verwandschaft“/„Beziehung“ (z.B. „Freund“) ist. Wenn „NULL“ angegeben ist, wird automatisch die sogenannte „FriendRelationshipID“ (entsprechender Eintrag in „CommunitySettings“) gewählt.
tinyint3.5.11
RelationshipDirection0 Gibt die „Richtung“ der Beziehung (aus Sicht des identifizierten Mitglieds) an :
„0“ : „ICH“ habe die Beziehung erstellt
„1“ : „ANDERE“ haben eine Beziehung zu „MIR“ erstellt
„2“ : Beide Richtungen
tinyint3.5.11
OutputCharacteristicID1NULL ID eines Merkmals. Falls angegeben, enthält die Rückgabemenge in der Spalte „Value1“ die Eigenschaft des jeweiligen Mitglieds zu diesem Merkmal. Das Merkmal muß aber durch den „Settings“-Eintrag zum Schlüssel „PublicCharacteristicIDs“ freigegeben sein !
smallint3.5.11
OutputCharacteristicID2NULL ID eines Merkmals. Falls angegeben, enthält die Rückgabemenge in der Spalte „Value2“ die Eigenschaft des jeweiligen Mitglieds zu diesem Merkmal. Das Merkmal muß aber durch den „Settings“-Eintrag zum Schlüssel „PublicCharacteristicIDs“ freigegeben sein !
smallint3.5.11
OutputCharacteristicID3NULL ID eines Merkmals. Falls angegeben, enthält die Rückgabemenge in der Spalte „Value3“ die Eigenschaft des jeweiligen Mitglieds zu diesem Merkmal. Das Merkmal muß aber durch den „Settings“-Eintrag zum Schlüssel „PublicCharacteristicIDs“ freigegeben sein !
smallint3.5.11
CommunityBinaryCategoryIDNULL Falls angegeben, enthält die Spalte „BinaryID“ der Rückgabemenge die kleinste „BinaryID“, die dem jeweiligen Mitglied in dieser Kategorie zugeordnet ist
smallint3.5.11
SeparatorInIdentVals'¶' Gibt an, durch welche Zeichenkette die Werte in „PersonIdentificationValues“ getrennt sind
varchar(4)5.5.0

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
CommunityMemberIDID eines Community-Mitglieds, zu dem eine Beziehung besteht
integer3.5.11
NicknameEigenschaft des Mitglieds „CommunityMemberID“ zu dem Merkmal, anhand dessen die Community-Mitglieder sich untereinander unterscheiden bzw. erkennen können. (Eintrag in „CommunitySettings“ zum Schlüssel „IdentifyingCharacteristicID“)
varchar(100)3.5.11
SortNoDie „Priorität“ der Beziehung
integer3.5.11
RelationshipDirectionRichtung der Beziehung aus Sicht des identifizierten Mitglieds :
„0“ : „ICH“ habe die Beziehung erstellt
„1“ : „ANDERE“ haben eine Beziehung zu „MIR“ erstellt
tinyint3.5.11
AccessLevelSumme von Zugriffsrechten, die das Mitglied „CommunityMemberID“ auf Daten des identifizierten Mitglieds hat bzw. umgekehrt (je nach „RelationshipDirection“). Mögliche Einzel-Zugriffsrechte : s. pm_GetRelationAccessLevels.
smallint5.1.10
OnlineStatusDieser Wert gibt an, wo ein Mitglied sich gerade in der Community aufhält. Es sind nur der Status „0“ [gerade angemeldet] und „255“ [Community verlassen] vom „dStore“ vorgegeben.
tinyint3.5.11
Value1Eigenschaft des Mitglieds „CommunityMemberID“ zum Merkmal „OutputCharacteristicID1“
varchar(100)3.5.11
Value1RestrictedByPatternWas enthält „Value1“ (womöglich wegen Zugriffsbeschränkungen nur einen Teil) ?
- NULL : den vollständigen Wert
- „#left(<n>)#“ : nur die ERSTEN n Zeichen
- „#right(<n>)#“ : nur die LETZTEN n Zeichen
Anmerkung : „n = 0“ möglich, „Value1“ ist dann NULL
varchar(100)6.5.4
Value2Eigenschaft des Mitglieds „CommunityMemberID“ zum Merkmal „OutputCharacteristicID2“
varchar(100)3.5.11
Value2RestrictedByPatternWie „Value1RestrictedByPattern“ - nur eben auf „Value2“ bezogen
varchar(100)6.5.4
Value3Eigenschaft des Mitglieds „CommunityMemberID“ zum Merkmal „OutputCharacteristicID3“
varchar(100)3.5.11
Value3RestrictedByPatternWas enthält „Value3“ (womöglich wegen Zugriffsbeschränkungen nur einen Teil) ?
- NULL : den vollständigen Wert
- „#left(<n>)#“ : nur die ERSTEN n Zeichen
- „#right(<n>)#“ : nur die LETZTEN n Zeichen
Anmerkung : „n = 0“ möglich, „Value3“ ist dann NULL
varchar(100)6.5.4
BinaryIDFalls „CommunityBinaryCategoryID“ angegeben wurde, steht hier die kleinste „BinaryID“, die dem Mitglied „CommunityMemberID“ in der Kategorie „CommunityBinaryCategoryID“ zugeordnet ist
integer3.5.11
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • RelationshipDirection (aufsteigend)
  • SortNo (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 5)
-781Fehlender oder falscher Eintrag in CommunitySettingsnur indirekt
-780Fehlender oder falscher Eintrag in CommunityMemberSettingsnur indirekt
-774Login vorübergehend gesperrtnur indirekt
-773Login gesperrtnur indirekt
-772User ist nicht angemeldetnur indirekt
-771Der Sweeper ist nicht gestartetnur indirekt
-770Login zur Zeit nicht möglichnur indirekt
-750Fehlende Berechtigung für die Anzeige der Datennur direkt
-660Identifikation fehlgeschlagennur indirekt
-621Fehlender oder falscher Eintrag in PersonTypeSettingsnur indirekt
-602Zur defaultUniqueID („VisitorID = -2“) können keinerlei Daten gespeichert oder verändert werdennur indirekt
-599Lizenz ist ungültig oder abgelaufennur indirekt
-569Der Benutzer hat kein Ausführungsrecht für die Prozedurnur indirekt
-567Die Prozedur darf z. Zt. nicht ausgeführt werdennur indirekt
-566Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werdennur indirekt
-550Fehlender oder falscher Eintrag in Settingsnur indirekt
-535Das Datum liegt nicht in der Vergangenheitnur indirekt
-530Der Wert ist nicht konvertierbarnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-504Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochennur indirekt
-502Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)nur indirekt
-500Falsche Parameterdirekt und indirekt

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

6.5.4 2013-04-291. Implementierung des neuen Merkmal-Zugriffsbeschränkungen-Features [⇒ auch Hinweis in der Doku]
2. Länge des Parameter „SeparatorInIdentVals“ wurde erweitert [von „1“ auf „4“]
3. Neue Rückgabespalten „Value…RestrictedByPattern“
5.5.0 2008-01-071. Neuer Parameter „SeparatorInIdentVals“
2. Vereinfachung der Fallunterscheidungen bei Ermittlung der Rückgabemenge
5.1.10 2007-03-121. Tabelle „PersonRelationships“ hat sich geändert ⇒ entsprechende Anpassungen
2. Parameter „RelationshipID“ ist jetzt ein „tinyint“ [vorher „integer“]
3. Neue Rückgabespalte „AccessLevel“
4. „print“-Ausgabe im Fehler-Fall „-500“
3.5.11 2001-09-06Erstmalig 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:

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/co_GetRelatedMembers_Pu?UniqueID=<value>&PersonIdentificationValues=<value>&CommunityID=<value>'

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/co_GetRelatedMembers_Pu?UniqueID=<value>&PersonIdentificationValues=<value>&CommunityID=<value>' | xmllint --format -
dStore_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_GetRelatedMembers_Pu',
		array(
			'UniqueID' => '<value>',
			'PersonIdentificationValues' => '<value>',
			'CommunityID' => <value>,
			// 'CommunityMemberID' => NULL,
			// 'RelationshipID' => NULL,
			// 'RelationshipDirection' => 0,
			// 'OutputCharacteristicID1' => NULL,
			// 'OutputCharacteristicID2' => NULL,
			// 'OutputCharacteristicID3' => NULL,
			// 'CommunityBinaryCategoryID' => NULL,
			// 'SeparatorInIdentVals' => '¶'
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();
engine/execute

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_GetRelatedMembers_Pu">
			<Parameters>
				<Parameter Name="UniqueID"><!-- varchar value --></Parameter>
				<Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter>
				<Parameter Name="CommunityID"><!-- smallint value --></Parameter>
				<!-- <Parameter Name="CommunityMemberID">NULL</Parameter> -->
				<!-- <Parameter Name="RelationshipID">NULL</Parameter> -->
				<!-- <Parameter Name="RelationshipDirection">0</Parameter> -->
				<!-- <Parameter Name="OutputCharacteristicID1">NULL</Parameter> -->
				<!-- <Parameter Name="OutputCharacteristicID2">NULL</Parameter> -->
				<!-- <Parameter Name="OutputCharacteristicID3">NULL</Parameter> -->
				<!-- <Parameter Name="CommunityBinaryCategoryID">NULL</Parameter> -->
				<!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
6)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/co_getrelatedmembers_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)