Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
— |
engine:procedures:au_modifyauctitsettsformode_ad [11.01.2016 ] (aktuell) |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
+ | ===== au_ModifyAuctItSettsForMode_Ad ===== | ||
+ | |||
+ | Verwaltet die Schlüssel, die zu einer Auktion in einem bestimmten Modus hinterlegt werden können bzw. müssen.\\ | ||
+ | |||
+ | Es gibt vom "dStore" vorgegebene Schlüssel, die durch "Required = 1" gekennzeichnet sind. Diese können NICHT gelöscht werden. Außerdem kann für diese NUR die Beschreibung geändert werden. ALLE Schlüssel, die NEU definiert werden, bekommen für "Required" den Wert "0" zugewiesen.\\ | ||
+ | |||
+ | Außerdem gibt es die Möglichkeit, Werte (-> "Value") zu einem Schlüssel (-> "KeyVariable") zu verwalten. Zusätzlich können Übersetzungen zu den Werten gepflegt werden.\\ | ||
+ | |HTTP-Method|POST | | ||
+ | |HTTP-Auth|Optional | | ||
+ | |Alias|au_ModifyAuctionItemSettingsForMode_Ad | | ||
+ | |Tags|{{tag>[au Modify Auction Item Settings For Mode Ad]}}| | ||
+ | |Engine-Kategorie|configurations | | ||
+ | |Engine-Typ|Daten-Änderung | | ||
+ | |Letzte Aktualisierung|7.0.7 (2015-01-29)| | ||
+ | |||
+ | ==== Parameter ==== | ||
+ | |||
+ | ^Name ((Pflichtparameter sind unterstrichen)) ^Standard-Wert ^Beschreibung ((siehe [[webservice:engine_parameterconventions|Parameter-Konventionen engine/<Prozedur-Name>]])) ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
+ | |__AuctionModeID__| |ID eines Auktions-Modus (siehe auch "au_GetAuctionModes")\\ |tinyint|3.5.22| | ||
+ | |__KeyVariable__| |Ein Schlüssel zum Auktions-Modus [[dstoreterm>AuctionModeID]] , der angelegt, geändert oder gelöscht werden soll\\ |varchar(50)|3.5.22| | ||
+ | |__Description__| |Beschreibung des Schlüssels "KeyVariable". Um nur die Werte bzw. Übersetzungen des Schlüssels zu verwalten, gibt man hierfür "NULL" an (dann ignoriert die Prozedur die Parameter "ValueFieldTypeID", "PredefinedValues" und "DeleteKeyVariable").\\ |varchar(255)|3.5.22| | ||
+ | |__ValueFieldTypeID__| |ID eines "Feld-Typs" - das beinhaltet z.B., ob es sich bei den Werten zum Schlüssel "KeyVariable" um Zahlen oder Datumsangaben etc. handeln muß. Kann nur geändert werden, wenn der Schlüssel noch NICHT verwendet wird !\\ |tinyint|3.5.22| | ||
+ | |PredefinedValues|1 |Wenn "PredefinedValues = 1" ist, kann ein Administrator, der zu einer Auktion im Modus [[dstoreterm>AuctionModeID]] einen Wert zu "KeyVariable" anlegen will, nur aus einer Liste von Werten auswählen. Änderung nur möglich, wenn "KeyVariable" nicht verwendet wird !\\ |bit|3.5.22| | ||
+ | |DeleteKeyVariable|0 |"1" angeben, um den (vorhandenen) Schlüssel "KeyVariable" zu löschen. Schlüssel, die "Required" (d.h. vom "dStore" aus vorgeschrieben) sind, können nicht gelöscht werden. Ebensowenig kann man Schlüssel löschen, die bereits verwendet werden.\\ |bit|3.5.22| | ||
+ | |Value|NULL |Ein Wert zum Schlüssel "KeyVariable". Der wird angelegt, wenn er neu ist, und gelöscht, falls "DeleteValue = 1". Falls der Wert schon existiert, kann man die Reihenfolge innerhalb aller Werte ändern (-> "SortNo") sowie Übersetzungen verwalten.\\ |varchar(100)|3.5.22| | ||
+ | |SortNo|1 |Bestimmt die Reihenfolge von "Value" innerhalb aller vordefinierten Werte zum Schlüssel "KeyVariable"\\ |smallint|3.5.22| | ||
+ | |DeleteValue|0 |"1" angeben, um den (vorhandenen) Wert "Value" zum Schlüssel "KeyVariable" zu löschen. Falls der Schlüssel nur vorefinierte Wert erlaubt ("PredefinedValues = 1"), darf der Wert nur gelöscht werden, falls er noch nicht verwendet wird.\\ |bit|3.5.22| | ||
+ | |LanguageID|NULL |ID einer Sprache, um die Beschreibung zum Schlüssel "KeyVariable" zu übersetzen (-> "Description") oder um den Wert "Value" in eine für einen Auktions-Teilnehmer verständlichen Sprache anzugeben (-> "ValueForParticipant")\\ |tinyint|3.5.22| | ||
+ | |ValueForParticipant|NULL |Eine Übersetzung des Wertes "Value" in einer für den Auktions-Teilnehmer verständlichen Sprache (-> "LanguageID"). Wenn es bereits eine Übersetzung gibt, und hier "NULL" angegeben ist, wird die vorhandene Übersetzung gelöscht (sonst geändert).\\ |varchar(100)|3.5.22| | ||
+ | ==== Rückgabe ==== | ||
+ | |||
+ | Die Prozedur hat keine Rückgaben. | ||
+ | ==== Output-Parameter ==== | ||
+ | |||
+ | Die Prozedur hat keine Output-Parameter.==== Mögliche Return-Codes ==== | ||
+ | |||
+ | ^Code ^Beschreibung ^Quelle ((direkt meint "von der Prozedur selber" und indirekt meint "von intern aufgerufenen Unterprozeduren")) ^ | ||
+ | |-1019|Der vordefinierte Wert kann nicht gelöscht werden, da es einen Eintrag in AuctionItemSettings gibt|nur direkt| | ||
+ | |-1018|Der Schlüssel aus AuctionItemSettingsForMode kann nicht (mehr) gelöscht/geändert werden|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| | ||
+ | |-532|Ungültiger Feldtyp|nur direkt| | ||
+ | |-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 [[http://resources.dstore.de/xsd/webservice_SmartGate/Response/EngineProcedure_v1_0.xsd|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\\ | | ||
+ | |5.1.2 |2006-06-26|Neuer möglicher Return-Code "-532", da es ab 5.1.2 "FieldTypes" mit einer "MaxLength > 100" geben kann !\\ | | ||
+ | |4.0.10 |2004-03-15|1. Interne Änderung : Änderung am Ende der Prozedur bzgl. "rollback tran"\\ 2. Fehlende Transaktion im "Ändern"- und "Anlegen"-Fall\\ | | ||
+ | |4.0.9 |2004-03-03|1. Aufruf der Prozeduren "_mi_StartProcedure" und "_mi_FinishProcedure" und Verwendung von "_mi_ChooseParamValueSeperator" als Vorbereitung von "_mi_StartProcedure"\\ 2. Ausführen von "set transaction isolation level 1" und "set rowcount 0" zu Beginn\\ | | ||
+ | |3.5.22 |2002-08-30|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: | ||
+ | * [[http://playground.dstore.de/index.php?proc=au_ModifyAuctItSettsForMode_Ad|au_ModifyAuctItSettsForMode_Ad im Engine Playground öffnen]] | ||
+ | == cURL == | ||
+ | Unformatierte Ausgabe: | ||
+ | <code bash> | ||
+ | curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/au_ModifyAuctItSettsForMode_Ad?AuctionModeID=<value>&KeyVariable=<value>&Description=<value>&ValueFieldTypeID=<value>'</code>Mit xmllint ((I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org)) formatierte Ausgabe: | ||
+ | <code bash> | ||
+ | curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/au_ModifyAuctItSettsForMode_Ad?AuctionModeID=<value>&KeyVariable=<value>&Description=<value>&ValueFieldTypeID=<value>' | xmllint --format -</code>== dStore_php == | ||
+ | <code 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'), | ||
+ | 'au_ModifyAuctItSettsForMode_Ad', | ||
+ | array( | ||
+ | 'AuctionModeID' => <value>, | ||
+ | 'KeyVariable' => '<value>', | ||
+ | 'Description' => '<value>', | ||
+ | 'ValueFieldTypeID' => <value>, | ||
+ | // 'PredefinedValues' => 1, | ||
+ | // 'DeleteKeyVariable' => 0, | ||
+ | // 'Value' => NULL, | ||
+ | // 'SortNo' => 1, | ||
+ | // 'DeleteValue' => 0, | ||
+ | // 'LanguageID' => NULL, | ||
+ | // 'ValueForParticipant' => NULL | ||
+ | ) | ||
+ | ); | ||
+ | |||
+ | $service->execute($request); | ||
+ | |||
+ | $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); | ||
+ | $ResultSet = $xml_result->getRowsAsArray(); | ||
+ | |||
+ | </code> | ||
+ | == engine/execute == | ||
+ | XML zur Ausführung mit der Methode [[:webservice:engine:execute|engine/execute]], z.B. per | ||
+ | curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>' | ||
+ | |||
+ | <code xml> | ||
+ | <?xml version="1.0" encoding="UTF-8"?> | ||
+ | <ListOfBatches> | ||
+ | <Batch No="0"> | ||
+ | <Procedure Name="au_ModifyAuctItSettsForMode_Ad"> | ||
+ | <Parameters> | ||
+ | <Parameter Name="AuctionModeID"><!-- tinyint value --></Parameter> | ||
+ | <Parameter Name="KeyVariable"><!-- varchar value --></Parameter> | ||
+ | <Parameter Name="Description"><!-- varchar value --></Parameter> | ||
+ | <Parameter Name="ValueFieldTypeID"><!-- tinyint value --></Parameter> | ||
+ | <!-- <Parameter Name="PredefinedValues">1</Parameter> --> | ||
+ | <!-- <Parameter Name="DeleteKeyVariable">0</Parameter> --> | ||
+ | <!-- <Parameter Name="Value">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="SortNo">1</Parameter> --> | ||
+ | <!-- <Parameter Name="DeleteValue">0</Parameter> --> | ||
+ | <!-- <Parameter Name="LanguageID">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="ValueForParticipant">NULL</Parameter> --> | ||
+ | </Parameters> | ||
+ | </Procedure> | ||
+ | </Batch> | ||
+ | </ListOfBatches></code> | ||