engine:procedures:co_getmemberinformation_pu
Inhaltsverzeichnis
co_GetMemberInformation_Pu
Mit dieser Prozedur können angemeldete Community-Mitglieder sich (z.B. in einem „Steckbrief“) Informationen zu anderen Mitgliedern (oder natürlich auch zu sich selbst…) anzeigen lassen.
Mit Informationen sind letztlich Eigenschaften zu bestimmten Merkmalen gemeint. Es können natürlich nicht alle Eigenschaften ermittelt werden, sondern nur Eigenschaften zu Merkmal-IDs, die in „CommunitySettings“ zum Schlüssel „PublicCharacteristicIDs“ konfiguriert sind. Außerdem werden nur Eigenschaften/Details zu „sichtbaren Merkmalen“ (s. Thema Zugriffsbeschränkungen bzw. Prozedur pm_GetPChAccRestrForUsers_Ad) zurückgegeben.
Anmerkung:
Um Eigenschaften MEHRERER Mitglieder zu ermitteln, ist co_GetMemberProperties_Pu zu verwenden.
| HTTP-Method | GET |
| HTTP-Auth | Optional |
| Tags | |
| Engine-Kategorie | communities |
| Engine-Typ | Daten-Ermittlung |
| Letzte Aktualisierung | 6.5.2 (2013-02-26) |
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.2 | |
| 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.2 | |
| CommunityID | ID einer Community | smallint | 3.5.2 | |
| GetInfoForCommunityMemberID | NULL | ID eines Mitglieds. „NULL“ bedeutet, daß die Eigenschaften zum identifizierten Mitglied ermittelt werden. Ein Wert ungleich „NULL“ setzt voraus, daß die IDs in „CharacteristicIDList“ in „PublicCharacteristicIDs“ aus „CommunitySettings“ existieren ! | integer | 3.5.2 |
| CharacteristicIDList | NULL | Liste von Merkmal-IDs (durch '¶' getrennt), zu denen die Eigenschaften ermittelt werden sollen. Bei Angabe von „NULL“ / „''“ werden die Eigenschaften zu allen Merkmal-IDs ermittelt, die in „PublicCharacteristicIDs“ aus „CommunitySettings“ angegeben sind. | varchar(255) | 3.5.2 |
| SortedResult | 0 | Bestimmt die Sortierung der Rückgabemenge. Diese ist nach den in „CharacteristicIDList“ angegebenen Merkmal-IDs geordnet, und zwar entweder * nach ihrer Reihenfolge im Parameter („0“) oder * nach ihrer „SortNo“ aus „PersonCharacteristics“ („1“). | bit | 3.5.2 |
| DateFormat | 'German' | Bestimmt das Format der Ausgabe von Datums-Eigenschaften. Falls „german“ oder „germany“ (Groß- und Kleinschreibung wird nicht beachtet) übergeben wird, sind Datums-Eigenschaften im Format „Tag-Monat-Jahr“, sonst „Monat-Tag-Jahr“. | varchar(10) | 3.5.2 |
| GetDetails | 0 | Möchte man „Details“ zu den gewünschten Merkmalen ausgegeben bekommen, übergibt man hier „1“. | bit | 5.0.0 |
| SeparatorInIdentVals | '¶' | Gibt an, durch welche Zeichenkette die Werte in „PersonIdentificationValues“ getrennt sind | varchar(4) | 5.5.0 |
Rückgabe
wenn GetDetails = 0
| Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
|---|---|---|---|
| SortNo5) | Wird nicht ausgegeben, sondern zur Sortierung der Rückgabemenge im Fall „SortedResult = 1“ verwendet. Bestimmt die Reihenfolge des Merkmals „CharacteristicID“ innerhalb aller Merkmale. | smallint | 3.5.2 |
| PositionOfCharacteristicIDInCharacteristicIDList6) | Wird nicht ausgegeben, bestimmt aber die Sortierung der Rückgabemenge im Fall „SortedResult = 0“. Das Ergebnis ist dann nach den in „CharacteristicIDList“ angegebenen Merkmal-IDs geordnet, und zwar nach ihrer Reihenfolge im Parameter | tinyint | 3.5.2 |
| CharacteristicDescription | Bezeichnung des Merkmals „CharacteristicID“ (in der Standardsprache) | varchar(100) | 3.5.2 |
| Value | Eigenschaft des Community-Mitglieds „GetInfoForCommunityMemberID“ zum Merkmal „CharacteristicID“. Kann aufgrund von Zugriffsbeschränkungen „NULL“ oder unvollständig sein, was dann durch „ValueRestrictedByPattern“ gekennzeichnet ist. | varchar(100) | 3.5.2 |
| ValueRestrictedByPattern | Was enthält „Value“ (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, „Value“ ist dann „NULL“ | varchar(100) | 6.5.2 |
| CharacteristicID | ID eines Personen-Merkmals (das in „CharacteristicIDList“ bzw. in „CommunitySettings“ zum Schlüssel „PublicCharacteristicIDs“ angegeben ist) | smallint | 3.5.2 |
| ValueID | ID der Eigenschaft „Value“ | integer | 3.5.2 |
Sortierungen der Rückgabe
wenn SortedResult = 0
- PositionOfCharacteristicIDInCharacteristicIDList (aufsteigend)
wenn SortedResult = 1
- SortNo (absteigend)
wenn GetDetails = 1
| Spaltenname | Beschreibung | SQL-Datentyp7) | ab Version |
|---|---|---|---|
| SortNo8) | Wird nicht ausgegeben, sondern zur Sortierung der Rückgabemenge im Fall „SortedResult = 1“ verwendet. Bestimmt die Reihenfolge des Merkmals „CharacteristicID“ innerhalb aller Merkmale. | smallint | 3.5.2 |
| PositionOfCharacteristicIDInCharacteristicIDList9) | Wird nicht ausgegeben, bestimmt aber die Sortierung der Rückgabemenge im Fall „SortedResult = 0“. Das Ergebnis ist dann nach den in „CharacteristicIDList“ angegebenen Merkmal-IDs geordnet, und zwar nach ihrer Reihenfolge im Parameter | tinyint | 3.5.2 |
| CharacteristicDescription | Bezeichnung des Merkmals „CharacteristicID“ (in der Standardsprache) | varchar(100) | 5.0.0 |
| Details | Die „Detail-Eigenschaft“ des Mitglieds zum Merkmal „CharacteristicID“ | text | 5.0.0 |
| CharacteristicID | ID eines Personen-Merkmals (das in „CharacteristicIDList“ bzw. in „CommunitySettings“ zum Schlüssel „PublicCharacteristicIDs“ angegeben ist) | smallint | 5.0.0 |
Sortierungen der Rückgabe
wenn SortedResult = 0
- PositionOfCharacteristicIDInCharacteristicIDList (aufsteigend)
wenn SortedResult = 1
- SortNo (aufsteigend)
Output-Parameter
Die Prozedur hat keine Output-Parameter.
Mögliche Return-Codes
| Code | Beschreibung | Quelle 10) |
|---|---|---|
| -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 |
| -750 | Fehlende Berechtigung für die Anzeige der Daten | 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 | direkt und 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 Response/EngineProcedure_v1_0.xsd validiert.
Historie
| 6.5.2 | 2013-02-26 | 1. Interne Anpassungen (Spalte „Visible“ von „PersonCharacteristics“ ist weggefallen) 2. Neue Rückgabespalte „ValueRestrictedByPattern“ 3. Datentyp-Länge von „SeparatorInIdentVals“ wurde erweitert |
| 5.5.1 | 2008-07-29 | Berücksichtigung des neuen „Settings“-Eintrags „AssignmentMethodForListVariables“ |
| 5.5.0 | 2008-01-07 | 1. Neuer Parameter „SeparatorInIdentVals“ 2. Ausgabe via „print“ im Fehler-Fall „-500“ (mit Informationen über die Ursache) 3. Bearbeitung des Quellcodes hinsichtlich neuer Konventionen 4. Zahlreiche Performance-Optimierungen |
| 5.0.0 | 2004-12-21 | 1. Der Parameter „DateFormat“ wurde bisher nicht (hinsichtlich „unsinniger“ Werte) überprüft 2. Neuer Parameter „GetDetails“ 3. Konsequente Fehlerbehandlung |
| 4.0.0 | 2003-04-03 | Merkmale, für die „Visible = 0“ [in „PersonCharacteristics“] ist, dürfen nicht beachtet werden ! |
| 3.5.5 | 2001-03-30 | |
| 3.5.2 | 2001-01-28 | 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:
cURL
Unformatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/co_GetMemberInformation_Pu?UniqueID=<value>&PersonIdentificationValues=<value>&CommunityID=<value>'
Mit xmllint 11) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/co_GetMemberInformation_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_GetMemberInformation_Pu', array( 'UniqueID' => '<value>', 'PersonIdentificationValues' => '<value>', 'CommunityID' => <value>, // 'GetInfoForCommunityMemberID' => NULL, // 'CharacteristicIDList' => NULL, // 'SortedResult' => 0, // 'DateFormat' => 'German', // 'GetDetails' => 0, // '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_GetMemberInformation_Pu"> <Parameters> <Parameter Name="UniqueID"><!-- varchar value --></Parameter> <Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter> <Parameter Name="CommunityID"><!-- smallint value --></Parameter> <!-- <Parameter Name="GetInfoForCommunityMemberID">NULL</Parameter> --> <!-- <Parameter Name="CharacteristicIDList">NULL</Parameter> --> <!-- <Parameter Name="SortedResult">0</Parameter> --> <!-- <Parameter Name="DateFormat">'German'</Parameter> --> <!-- <Parameter Name="GetDetails">0</Parameter> --> <!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
, 6)
, 8)
, 9)
Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.
10)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
11)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/co_getmemberinformation_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)