co_ModifyCommunitySettings_Ad [dstore]

Inhaltsverzeichnis

co_ModifyCommunitySettings_Ad

co_ModifyCommunitySettings_Ad

Verwaltet die „Settings“-Einträge von Communities.

Anmerkungen zum Parameter „KeyVariable“ :

1.) Mögliche Werte erhält man durch den Aufruf von „exec do_GetSettingsDescriptions_Ad SettingsTable = 'CommunitySettings' „

2.) Beim speziellen Schlüssel „IdentifyingCharacteristicID“ darf in „Value“ KEINE ID eines Personen-Merkmals angegeben werden, zu dem lesende Zugriffsbeschränkungen existieren (sonst gibt es einen Fehler) !

HTTP-Method	POST
HTTP-Auth	Optional
Tags	[co, Modify, Community, Settings, Ad]
Engine-Kategorie	configurations
Engine-Typ	Daten-Änderung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
CommunityID		ID einer Community	smallint	3.5.0
KeyVariable		Ein Schlüssel, der zu einer Community hinterlegt werden kann. Falls der Schlüssel noch nicht existiert, wird er angelegt, andernfalls - „Value“ entsprechend - geändert bzw. (falls „Value = NULL“) gelöscht.	varchar(100)	3.5.0
Value	NULL	Wert, der zum Schlüssel „KeyVariable“ in der Community „CommunityID“ gesetzt werden soll. „NULL“ bedeutet, daß der Wert gelöscht werden soll.	varchar(100)	3.5.0

Rückgabe

Die Prozedur hat keine Rückgaben.

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁴⁾
-697	Aktion kann nicht durchgeführt werden, da für ein Merkmal eine Zugriffsbeschränkung besteht	nur direkt
-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
-553	Der Settings-Eintrag darf nicht gelöscht werden	nur direkt
-540	Falsches Format	nur direkt
-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	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
6.5.2	2013-02-26	Holger Wies : Bei Anlage bzw. Änderung prüfen, ob es sich um eine „Setting“ mit Personen-Merkmal-IDs handelt und es beim neuen Wert ggf. um die ID eines Merkmals mit Zugriffsbeschränkung handelt. Wenn ja, wird nun ein Fehler geworfen.
4.0.10	2004-03-15	1. 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.20	2002-07-22
3.5.11	2001-09-06
3.5.0	2000-11-23	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_ModifyCommunitySettings_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/co_ModifyCommunitySettings_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_ModifyCommunitySettings_Ad',
		array(
			'CommunityID' => <value>,
			'KeyVariable' => '<value>',
			// 'Value' => 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_ModifyCommunitySettings_Ad">
			<Parameters>
				<Parameter Name="CommunityID"><!-- smallint value --></Parameter>
				<Parameter Name="KeyVariable"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="Value">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾

siehe Datentypen im Bereich "engine"

⁴⁾

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