Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:co_getmembersettings_ad

co_GetMemberSettings_Ad

Gibt für ein Community-Mitglied die Einstellungen aus „CommunityMemberSettings“ zurück.

HTTP-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategoriecommunities
Engine-TypDaten-Ermittlung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
CommunityIDNULL ID einer Community. Falls „NULL“ angegeben wird, gibt die Prozedur die „Settings“-Einträge der Person „CommunityMemberID“ ALLER Communities zurück (in denen sie Mitglied ist).
smallint3.5.0
CommunityMemberID ID eines Mitglieds der Community „CommunityID“ bzw. irgendeiner Community
integer3.5.0
KeyVariableNULL Ein Schlüssel aus „CommunityMemberSettings“, zu dem der für das Mitglied „CommunityMemberID“ hinterlegte Wert zurückgegeben werden soll. „NULL“ bedeutet, daß man die Werte zu ALLEN Schlüsseln zurückbekommen möchte.
varchar(100)3.5.0

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
CommunityIDID einer Community. Entweder „CommunityID“ oder die ID einer Community, in der „CommunityMemberID“ Mitglied ist.
smallint3.5.0
CommunityNameName der Community „CommunityID“
varchar(100)3.5.0
CommunityMemberIDHier steht z.Zt. Immer die „CommunityMemberID“ - da es aber evtl. in einer zukünftigen Version möglich sein wird, sich die „Settings“-Einträge MEHRER Mitglieder ermitteln zu lassen, existiert diese Rückgabespalte.
integer3.5.0
KeyVariableEin Schlüssel aus „CommunityMemberSettings“ bzw. „KeyVariable“
varchar(50)3.5.0
ValueDer zum Schlüssel „KeyVariable“ hinterlegte Wert des Mitglieds „CommunityMemberID“ in der Community „CommunityID“
varchar(100)3.5.0

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 5)
-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
-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 Parameternur 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-29Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
6.5.4 2013-04-29Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
4.0.10 2004-03-151. Aufruf der Prozeduren „_mi_StartProcedure“, „_mi_FinishProcedure“ und „_mi_ChooseParamValueSeperator“
2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
3.5.2 2001-01-28
3.5.0 2000-11-23Erstmalig 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_GetMemberSettings_Ad?CommunityMemberID=<value>'

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/co_GetMemberSettings_Ad?CommunityMemberID=<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_GetMemberSettings_Ad',
		array(
			'CommunityMemberID' => <value>,
			// 'CommunityID' => NULL,
			// 'KeyVariable' => NULL
		)
);
 
$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_GetMemberSettings_Ad">
			<Parameters>
				<Parameter Name="CommunityMemberID"><!-- integer value --></Parameter>
				<!-- <Parameter Name="CommunityID">NULL</Parameter> -->
				<!-- <Parameter Name="KeyVariable">NULL</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_getmembersettings_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)