Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:co_getcommunitysettings

co_GetCommunitySettings

Ermittelt die „Settings“-Einträge (optional nur zu einem bestimmten Schlüssel) aller Communities (oder auch nur zu einer bestimmten Community).

HTTP-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategoriecommunities
Engine-TypDaten-Ermittlung
Letzte Aktualisierung3.5.2 (2001-01-28)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
CommunityIDNULL ID einer Community, zu der die „Settings“-Einträge ermittelt werden sollen. Falls „NULL“, ermittelt die Prozedur die Einträge zu allen Communities.
smallint3.5.2
KeyVariableNULL Ein Schlüssel wie z.B. „CommunityGroupID“. Falls „NULL“, werden alle „Settings“-Einträge der Community „CommunityID“ zurückgegeben.
varchar(100)3.5.2
ResultOnlyInOutputParam0 Wird nur beachtet, falls „CommunityID“ UND „KeyVariable“ angegeben sind ! Wenn hier „0“ übergeben wird, gibt es eine Rückgabemenge, sonst ist der Wert nur in „Value“ gespeichert.
bit3.5.2

Rückgabe

wenn ResultOnlyInOutputParam = 0

Spaltenname Beschreibung SQL-Datentyp4) ab Version
CommunityIDID einer Community
smallint3.5.2
CommunityNameName der Community „CommunityID“
varchar(100)3.5.2
KeyVariableEin Schlüssel wie z.B. „CommunityGroupID“, zu dem für die Community „CommunityID“ ein Wert hinterlegt ist
varchar(50)3.5.2
ValueDer in der Community „CommunityID“ zum Schlüssel „KeyVariable“ hinterlegte Wert
varchar(100)3.5.2

wenn CommunityID is NULL und ResultOnlyInOutputParam = 1

Spaltenname Beschreibung SQL-Datentyp5) ab Version
CommunityIDID einer Community
smallint3.5.2
CommunityNameName der Community „CommunityID“
varchar(100)3.5.2
KeyVariableEin Schlüssel wie z.B. „CommunityGroupID“, zu dem für die Community „CommunityID“ ein Wert hinterlegt ist
varchar(50)3.5.2
ValueDer in der Community „CommunityID“ zum Schlüssel „KeyVariable“ hinterlegte Wert
varchar(100)3.5.2

wenn KeyVariable is NULL und ResultOnlyInOutputParam = 1

Spaltenname Beschreibung SQL-Datentyp6) ab Version
CommunityIDID einer Community
smallint3.5.2
CommunityNameName der Community „CommunityID“
varchar(100)3.5.2
KeyVariableEin Schlüssel wie z.B. „CommunityGroupID“, zu dem für die Community „CommunityID“ ein Wert hinterlegt ist
varchar(50)3.5.2
ValueDer in der Community „CommunityID“ zum Schlüssel „KeyVariable“ hinterlegte Wert
varchar(100)3.5.2

Output-Parameter

ValueAusgabeparameter für den zum Schlüssel „KeyVariable“ hinterlegten Wert

Mögliche Return-Codes

Code Beschreibung Quelle 7)
-781Fehlender oder falscher Eintrag in CommunitySettingsnur direkt

XML-Schema

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

Historie

3.5.2 2001-01-28Erstmalig 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_GetCommunitySettings'

Mit xmllint 8) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/co_GetCommunitySettings' | 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_GetCommunitySettings',
		array(
			// 'CommunityID' => NULL,
			// 'KeyVariable' => NULL,
			// 'ResultOnlyInOutputParam' => 0
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();
 
$OutputParams = $xml_result->getOutputParametersAsArray();
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_GetCommunitySettings">
			<Parameters>
				<!-- <Parameter Name="CommunityID">NULL</Parameter> -->
				<!-- <Parameter Name="KeyVariable">NULL</Parameter> -->
				<!-- <Parameter Name="ResultOnlyInOutputParam">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
7)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
8)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/co_getcommunitysettings.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)