fo_ModifyPredValsForCharacs_Ad [dstore]

Inhaltsverzeichnis

fo_ModifyPredValsForCharacs_Ad

fo_ModifyPredValsForCharacs_Ad

Prozedur zum Verwalten von vordefinierten Werten für Posting-Merkmale.

Hintergrund : Zu Forum-Beiträgen können Eigenschaften hinterlegt werden. Diese Eigenschaften gehören immer zu sogenannten Merkmalen (die quasi die Eigenschaften charakterisieren). Bestimmte Merkmale zeichnen sich dadurch aus, daß die Beiträge nur Eigenschaften zugewiesen bekommen können, die in einer Liste von vordefinierten Werten vorkommen.

HTTP-Method	POST
HTTP-Auth	Optional
Alias	fo_ModifyPredefinedValuesForPostingCharacteristics_Ad
Tags	[fo, Modify, Predefined, Values, For, Posting, Characteristics, 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
PostingCharacteristicID		ID des Posting-Merkmals, zu dem die vordefinierten Werte verwaltet werden sollen	smallint	4.0.16
OldValue	NULL	Ein bestehender vordefinierten Wert zum Merkmal „PostingCharacteristicID“. Falls angegeben, wird dieser geändert (auf „Value“, falls angegeben) oder gelöscht (falls „Value = NULL“ ist). Übergibt man hierfür „NULL“, wird der neue Wert „Value“ angelegt.	varchar(250)	4.0.16
Value		Der neue vordefinierte Wert (falls „OldValue = NULL“ ist) bzw. der neue Wert, auf den der bestehende Wert „OldValue“ geändert werden soll. Anmerkung : Die Angabe von „NULL“ sowohl für „OldValue“ als auch für „Value“ führt zum Fehler „-500“ !	varchar(250)	4.0.16
OnlyValidForForumID	NULL	ID eines Forums. Falls angegeben (und wenn „Value“ NICHT „NULL“ ist), können nur Beiträge dieses Forums den Wert „Value“ als Eigenschaft zugewiesen bekommen.	smallint	4.0.16
Country	'german'	Nur relevant, falls es sich bei „Value“ um einen Datums-Wert handelt. Gibt an, in welchem Format der Wert ist (Groß- und Kleinschreibung wird nicht beachtet) : „german“ (oder „germany“) : Tag-Monat-Jahr „english“ (oder „england“) : Monat-Tag-Jahr	varchar(10)	4.0.16

Rückgabe

Die Prozedur hat keine Rückgaben.

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁴⁾
-873	Der vordefinierte Wert kann nicht für das Forum angelegt werden, da das Merkmal nicht zugeordnet ist	nur direkt
-872	Der vordefinierte Wert ist bereits vorhanden	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
-540	Falsches Format	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.3	2013-03-18	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
4.0.16	2004-08-31	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:

fo_ModifyPredValsForCharacs_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/fo_ModifyPredValsForCharacs_Ad?PostingCharacteristicID=<value>&Value=<value>'

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/fo_ModifyPredValsForCharacs_Ad?PostingCharacteristicID=<value>&Value=<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'),
	'fo_ModifyPredValsForCharacs_Ad',
		array(
			'PostingCharacteristicID' => <value>,
			'Value' => '<value>',
			// 'OldValue' => NULL,
			// 'OnlyValidForForumID' => NULL,
			// 'Country' => 'german'
		)
);
 
$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="fo_ModifyPredValsForCharacs_Ad">
			<Parameters>
				<Parameter Name="PostingCharacteristicID"><!-- smallint value --></Parameter>
				<Parameter Name="Value"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="OldValue">NULL</Parameter> -->
				<!-- <Parameter Name="OnlyValidForForumID">NULL</Parameter> -->
				<!-- <Parameter Name="Country">'german'</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