co_SearchMemberSettings_Ad [dstore]

Inhaltsverzeichnis

co_SearchMemberSettings_Ad

co_SearchMemberSettings_Ad

Mit Hilfe dieser Prozedur kann ein Administrator in einer Community nach allen Mitgliedern suchen, die irgendeinen oder einen bestimmten Eintrag zu einem bestimmten Schlüssel hinterlegt haben.

Anmerkung zur Rückgabespalte „IdentifyingValue“ :

Eine evtl. konfigurierte Zugriffsbeschränkung für das „Nickname“-Merkmal (s. pm_GetPChAccRestrForUsers_Ad), das in dieser Rückgabespalte herangezogen wird, wird bewußt NICHT beachtet (da das ja DIE öffentlich sichtbare Eigenschaft in einer Community schlechthin ist) !

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[co, Search, Member, Settings, Ad]
Engine-Kategorie	communities
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
CommunityID		ID einer Community	smallint	3.5.7
KeyVariable		Ein Schlüssel aus „CommunityMemberSettings“, nach dem gesucht werden soll	varchar(50)	3.5.7
Value	NULL	Ein Wert zum Schlüssel „KeyVariable“. Wenn angegeben, werden nur die Mitglieder zurückgegeben, die diesen Wert (Groß- und Kleinschreibung spielt keine Rolle) hinterlegt haben.	varchar(100)	3.5.7
FromRowNumber	1	Es werden maximal „MaxNumberOfRows“ (also höchstens 255) Datensätze ausgegeben. Mit Hilfe dieses Parameters (und „MaxNumberOfRows“) kann man sich aber durch das Gesamtergebnis „blättern“.	integer	3.5.7
MaxNumberOfRows	50	Gibt an, wieviele Datensätze maximal zurückgegeben werden sollen (höchstens 255)	tinyint	3.5.7
OrderByColumn	1	Nach welcher Rückgabe-Spalte soll das Ergebnis sortiert werden ?	tinyint	3.5.7
OrderByLowerValues	0	Falls „OrderByColumn“ den Wert „2“ oder „3“ besitzt, entscheidet dieser Parameter darüber, ob bei der Sortierung die Groß- und Kleinschreibung beachtet werden soll oder nicht	bit	3.5.20

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
lower(SettingValue)⁵⁾	Wird nur zur Sortierung im Fall „OrderByColumn = 3“ und „OrderByLowerValue = 1“ verwendet. Enthält „SettingValue“ komplett „lowercase“ (Kleinbuchstaben)	varchar(100)	3.5.0
lower(IdentifyingValue)⁶⁾	Wird nur zur Sortierung im Fall „OrderByColumn = 2“ und „OrderByLowerValue = 1“ verwendet. Enthält „IdentifyingValue“ komplett „lowercase“ (Kleinbuchstaben)	varchar(100)	3.5.0
CommunityMemberID	ID eines Community-Mitglieds, das einen Eintrag (bzw. den Eintrag „Value“) zum Schlüssel „KeyVariable“ hinterlegt hat	integer	3.5.0
IdentifyingValue	Eigenschaft 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.0
SettingValue	Der Wert, den das Mitglied „CommunityMemberID“ zum Schlüssel „KeyVariable“ in der Community „CommunityID“ hinterlegt hat	varchar(100)	3.5.0

Sortierungen der Rückgabe

wenn OrderByColumn = 1

CommunityMemberID (aufsteigend)

wenn OrderByColumn = 2 und OrderByLowerValues = 0

IdentifyingValue (aufsteigend)

wenn OrderByColumn = 2 und OrderByLowerValues = 1

lower(IdentifyingValue) (aufsteigend)

wenn OrderByColumn = 3 und OrderByLowerValues = 0

SettingValue (aufsteigend)

wenn OrderByColumn = 3 und OrderByLowerValues = 1

lower(SettingValue) (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁷⁾
-781	Fehlender oder falscher Eintrag in CommunitySettings	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
-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 Response/EngineProcedure_v1_0.xsd validiert.

Historie

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. Konsequente Fehlerbehandlung
3.5.20	2002-07-22
3.5.7	2001-05-04	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:

co_SearchMemberSettings_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁸⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/co_SearchMemberSettings_Ad?CommunityID=<value>&KeyVariable=<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_SearchMemberSettings_Ad',
		array(
			'CommunityID' => <value>,
			'KeyVariable' => '<value>',
			// 'Value' => NULL,
			// 'FromRowNumber' => 1,
			// 'MaxNumberOfRows' => 50,
			// 'OrderByColumn' => 1,
			// 'OrderByLowerValues' => 0
		)
);
 
$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_SearchMemberSettings_Ad">
			<Parameters>
				<Parameter Name="CommunityID"><!-- smallint value --></Parameter>
				<Parameter Name="KeyVariable"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="Value">NULL</Parameter> -->
				<!-- <Parameter Name="FromRowNumber">1</Parameter> -->
				<!-- <Parameter Name="MaxNumberOfRows">50</Parameter> -->
				<!-- <Parameter Name="OrderByColumn">1</Parameter> -->
				<!-- <Parameter Name="OrderByLowerValues">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾ , ⁶⁾

Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.

⁷⁾

direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“

⁸⁾

I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Inhaltsverzeichnis